(A.K.A. We ❤️ PR's)
There are many ways you can contribute to this project (even without code), and we'd love for you to do it!
Here are some examples:
- Report an issue
- Help us with a reported issue
- Create a pull Request
- Help us Develop a Feature
- Help us with Documentation
- Host your own NodeSchool Event!
-
Help us with Examples -
Help us with the Wiki -
Help us with a translation
(How to get along with others)
- Please Write Comments - You don't need to comment every line though, but it helps everyone doing a code review understand what are you trying to accomplish in the PRs.
- We use the JavaScript Standard Style to have a consistent development style. We also use Markdownlint to make sure that the markdown files look pretty.
- Contributions are submitted, reviewed, and accepted using pull requests.
- The latest releases are in the master branch.
- Test before you make a Pull Request.
- Test before you make a Pull Request.
- Keep it compatible. Try to not introduce breaking changes, (Although we know
that sometimes those changes are a must)
npm run test - (Further suggestions welcome)
I bet this is not the first time you are contributing to a Open Source Project (If it is, congrats and welcome!!). Just in case you forgot, here is a quick 6 steps on how to do it.
- First, Fork the repo
- Clone the forked repo ->
git clone [email protected]:<your-user-name>/admin.git - Install dependencies ->
npm install - (Make sure the tests pass) ->
npm run test - Make your changes. Add tests for your changes.
Please, also make sure the tests pass with
npm run test - Push to your fork and make a pull request
You can always reach out to one of the maintainers