-
Notifications
You must be signed in to change notification settings - Fork 654
Contributing
I aim to be the most-welcoming, and least-pedantic maintainer I can be.
Software is daunting enough.
Contributing on github should be a light, easy, non-scary
thing to do.
![]() |
that copies the project to your personal github,
where you can make whatever changes you want.
|
![](https://user-images.githubusercontent.com/399657/53584789-66d36d80-3b52-11e9-9fe3-ce3e1d91b25f.png)
get your link from this button:
![]() |
you'll need to have git, and maybe some github tokens setup
but now you're able to see it on your computer
|
![]() |
this will download the random things your computer needs to run (you'll need npm installed - but that's pretty easy) this actually works pretty well usually. |
![]() |
π
|
npm run start
or npm run watch
.
![]() |
|
![]() |
git add any changed files git commit - add a small message git push - upload it to github |
![]() |
github does a pretty-good job at this. say hello! explain your changes a little bit. |
If it's a big change, or you're going to be adding new features, you may want to open an issue to chat about it first.
- sometimes there are concerns, or discussions to have.
- sometimes maintainers have automatic tests that run during a pull request.
- some maintainers ignore good Pull Requests, which is rude. (It sometimes happens!)
- maintainers have a hard job.
-
best to ensure the tests are still passing, after you've made your changes
-
Bonus points for adding more tests, for the new stuff you're adding.
-
to change your PR, you can simply do another commit+push, it appears automatically.
-
try to keep your Pull Request small, so it's easy to review.
-
no-need to commit new builds, or increment version numbers. Let maintainers do that.
-
it may take some time before your change enters a new release. Don't sweat.
After a few times, this stuff gets easier, I promise.
It used to be so much harder.
git, github, homebrew, and nodejs have really lowered the barrier to software projects. A lot of tools, and help are available
Compromise is written in es5 javascript. We've got some eslint and esformatter files in the repo that should 'just work' with prettier or standard.. Who cares though.
π