diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..81124e3 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,20 @@ +# Contributing: + +### Best Practices for reporting or requesting for Issues/Enhancements: + - Follow the Issue Template while creating the issue. + - Include Screenshots if any (specially for UI related issues) + - For UI enhancements or workflows, include mockups to get a clear idea. + +### Best Practices for assigning an issue: +- If you would like to work on an issue, inform in the issue ticket by commenting on it. +- Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator. + +Note: Please do not work on issues which is already being worked on by another contributor. We don't encourage creating multiple pull requests for the same issue. Also, please allow the assigned person some days to work on the issue ( The time might vary depending on the difficulty). If there is no progress after the deadline, please comment on the issue asking the contributor whether he/she is still working on it. If there is no reply, then feel free to work on the issue. + + +### Best Practices to send Pull Requests: + - Follow the Pull request template. + - Commit messages should follow this template: `Fix # - ` + - Squash all your commits to a single commit. + - Create new branch before adding and commiting your changes ( This allows you to send multiple Pull Requests ) + \ No newline at end of file