We welcome contributions from the open-source community to help make this repository better. Before you start contributing, please read through the following guidelines.
Here are a few examples of the types of contributions we welcome:
- your own JavaScript mini-projects with adequate commentary
- Bug reports and fixes
- Feature requests and implementation
- Documentation improvements
- Test coverage
Here are the steps to follow to make a contribution:
- If starting from scratch, Fork the repository.
- Create a new branch with a descriptive name (e.g.,
fix-typo-in-readme). - If you've forked already, sync your Fork with the submissions branch.
- Make changes as you see fit.
- Run tests and make sure everything is working.
- Commit your changes with a descriptive message (More details are encouraged).
- Submit a pull request to the submissions repository.
- Keep an eye out for comments and feedback.
PLEASE SUBMIT ALL PULL REQUESTS TO THE "SUBMISSIONS BRANCH" ALL PULL REQUESTS TO MAIN WILL BE REJECTED
Please follow the coding style used in the original repository.
- To avoid a bloated dependency list, please try install your dependencies in the appropriate subdirectory.
- For example, if you need to
npm install mongooseplease cd into the mongoose directory to do so. - Pull requests with root directory npm installs will be rejected!
By contributing to this repository, you agree to release your contributions under the MIT License.
This repository has a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please make sure you read it and follow its guidelines.
Thank you for your interest in contributing to Quick JavaScript Refreshers! We look forward to your contributions!