👍🍕 Thanks for your time to contribute. Your help is essential for keeping it great. 🍕👍
Contributions to this project are released to the public under the project's license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone my repository to yours.
- Create a new branch:
git checkout -b your-branch-name. Meaningful branch name is good, e.g. new feature called "awesome feature":feat-awesome-feature, fix bug in magic-function:fix-magic-function. - Work on your code... (Thanks!!)
- Make sure the tests still pass. Depends on the project, there may be vary commands available, e.g.
npm run testfor node project. - Push to your fork and submit a pull request. Remember that you should submit your feature branch, e.g.
feat-awesome-feature,fix-magic-function, etc. Highly recommend enabling "Allow edits from maintainers". - Wait for your pull request to be reviewed and merged.
Sometimes you may want to fix a typo, or do a small change that doesn't need a test, you can propose file change directly.
reference: Editing files in another user's repository - Github Help
If you are shy in Github, feel free to connect me via edditoria@gmail.com | @Edditoria | facebook.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow standards for style and code quality.
- Follow the code style in this repository. Usually you can follow the file
<.editorconfig>. - Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.