How to make a contribution
Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
- Fork this repository to your own GitHub account. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
- Clone the repository to your local machine using
git clone https://github.com/your-GitHub-username/express-http-context.git. - Create a new branch for your changes using
git checkout -b branch-name-here. - Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Add tests for new code. If you are submitting a bug fix, consider writing the test first. A good test will fail until your finish writing the fix.
- If this is your first time contributing to this project, feel free to add your name to the bottom of the README. :D
- Commit your changes and push them to your fork.
- Submit a pull request from your fork to
skonves/express-http-context. The title should be a short description of the changes you made. - In the description of your pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
- Wait for the pull request to be reviewed by a maintainer.
- Make changes to the pull request if the reviewing maintainer recommends them.
- Celebrate your success after your pull request is merged!