We want contributing to reference-js to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including new docs as well as updates, tweaks and more.
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make an individual pull request for each suggestion.
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
- End all descriptions with a full stop/period.
- Check your spelling and grammar.
When you clone the repository, include your function in index.js and use node to test with example.js.
- Clone the repository
- Create your branch:
git checkout -b my-new-branch - Commit your changes:
git commit -am 'Fixed typo' - Push to the branch:
git push origin my-new-branch - Submit a pull request
A maintainer may ask you to edit your Pull Request before it is included, this is standard procedure.