Skip to content

Commit

Permalink
Adding: Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AkshGautam authored and therajanmaurya committed Aug 15, 2018
1 parent 23a7cb9 commit 085e144
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -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 #<issue-no> - <issue-desc>`
- 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 )

0 comments on commit 085e144

Please sign in to comment.