add CONTRIBUTING file

This commit is contained in:
Vishwas Shashidhar 2018-06-25 14:55:28 +05:30 committed by GitHub
parent 5ad6ca12d0
commit 94a361986d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

23
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,23 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Issue Process
1. Ensure that you fill up the issue template with appropriate details before creating the issue
2. Tag issues with appropriate labels for future usage
3. If issues are unanswered / not responded for more than 30 days, they'll be closed by the maintainers in which case you'll need to create a new issue and link it to the old issue.
4. Ensure you check if there are existing issues similar to what your issue is before creating a new one
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Ensure unit & automation tests are run and corresponding proof documents are attached
3. Tag pull requests with appropriate labels for future usage
4. Tag / add reviewers you'd like to review in the PR
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.