octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-11-04 20:38:03 +00:00
Code Issues Releases Activity

Dev.md: guidelines (PR #1133)

Browse Source 
An attempt to a few important things to newcomers, to reduce the risk
of contributors being disappointed / contradicted late at PR time.
This commit is contained in:
Ronan Jouchet 2021-03-11 20:27:21 -05:00 committed by GitHub
parent eaa9d8471b
commit 3c2e84a752
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/development.md
View File

@ -1,5 +1,25 @@
# Development Guide
Welcome, soon-to-be contributor 🙂! This document sums up what you
need to know to get started hacking on Nativefier.
## Guidelines
1. Before starting work on a huge change, gauge the interest
of community & maintainers through a GitHub issue.
For big changes, create a [RFC])(https://en.wikipedia.org/wiki/Request_for_Comments)
issue to enable a good peer review.
2. Do your best to avoid adding new Nativefier command-line options.
If a new option is inevitable for what you want to do, sure,
but as much as possible try to see if you change works without.
Nativefier already has a ton of them, making it hard to use.
3. Avoid or limit adding npm dependencies.
Each new dependency is a complexity & security liability.
4. Use types, avoid `any`, write tests. In that order.
5. Document for users in API.md
6. Document for other devs in comments, jsdoc, commits, PRs.
Say *why* more than *what*, the *what* is your code!
## Setup
First, clone the project: