You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 8, 2018. It is now read-only.
Copy file name to clipboardExpand all lines: docs/Contribution.md
+40-5Lines changed: 40 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,47 @@ The instructions given below are for software developers who want to work on [ou
13
13
14
14
3. Create a new issue, a community member will get back to you and once approved, send a pull request for the same.
15
15
16
-
4.Please go through the issue list first (both open as well as closed) amd make sure the issue you are reporting does not replicate the issues already reported. Clearly explain what the exact issue is and provide the steps to recreate it as well, if possible.
16
+
4.All the PRs are needed to be sent to the [develop](https://github.com/systers/macc) branch.
17
17
18
-
5. If you have issues on multiple pages, then report them separately. Do not combine them into a single issue.
18
+
## Avoid doing the following mistakes
19
+
1. Fix a new issue and submit a PR without reporting and getting it approved at first.
19
20
20
-
6. All the PRs are needed to be sent to the [develop](https://github.com/systers/macc) branch. Do not add merge commits to your PR.
21
+
2. Fix an issue assigned to somebody else and submit a PR before the assignee does.
21
22
22
-
7. If you're sending a PR for UI improvement or fix, make sure you add a screenshot to validate the changes you've made. Give a brief description of the steps taken by you.
23
+
3. Report issues which are previously reported by others. (Please check the closed issues too before you report an issue).
24
+
25
+
4. Suggest completely new developments in the issue list. (Please use the mailing list for this kind of suggestions. Use issue list to suggest bugs/features in the already implemented sections.)
26
+
27
+
## Best Practices
28
+
### For Issue Reporting
29
+
1. Go through the Issue List and see whether the issue you found or any related issue is already reported.
30
+
31
+
2. If you don't find the issue you are reporting in issue list, check whether it is reported and closed (present in closed issue list).
32
+
33
+
3. If the issue is new, report the issue as a new one with following:
34
+
* Screen shot if possible
35
+
* Short description for the title
36
+
* A detailed description with steps to recreate the issue (for bugs)
37
+
* A description of how the issue will improve the application ( for enhancements)
38
+
39
+
### For Pull Requests
40
+
1. Use meaningful commit messages.
41
+
42
+
2. Do not over commit. (Do not include multiple commits for a small change)
43
+
44
+
3. Do not add the merge commits to the PR.
45
+
46
+
4. Usually use a single commit for a single issue, unless the issues are related or contain a significant code change.
47
+
48
+
5. There are certain kind of files you do not add to source control (Like the vitual environment folder). If you already don't know about them, please do a quick search and find them and remove them from your commit.
49
+
50
+
6. When sending a PR have an appropriate title referencing the issue which it solves.
51
+
52
+
7. If it is a UI change, add a screen shot of the new/fixed UI.
53
+
54
+
8. Have a short description on what has gone wrong (like a root cause analysis and description of the fix), if that information is not already present in the issue.
55
+
56
+
9. Do not ask us to review it in a separate comment. We will review it anyway.
23
57
24
58
25
59
## Coding Style and Standards
@@ -106,7 +140,8 @@ Avoid doing `$ git add --all` since it also adds the changes needed specifically
106
140
107
141
If you need more references and Git expertise, a good resource is the [Git Book](https://git-scm.com/book/en/v2).
108
142
109
-
143
+
##Troubleshooting
144
+
If there are any other questions or concerns, you can either send a mail to the systers-dev mailing list or join #macc channel in our slack group. To get an invitation to the slack group [click here] (http://systers.io/slack-systers-opensource/).
0 commit comments