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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-15
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,20 @@
3
3
Thanks for your interest in helping out! Here are a **few**_weird_ tricks to
4
4
~~cut your mortgage in half~~ maximize the global net efficiency of your efforts!
5
5
6
+
## TL;DR: Checklist
7
+
8
+
When opening an [issue](#issues):
9
+
-[ ] search open/closed issues
10
+
-[ ] discuss bug/enhancement in new or old issue
11
+
12
+
[PR](#prs) time:
13
+
-[ ] write tests
14
+
-[ ] implement feature/fix bug
15
+
-[ ] update docs
16
+
-[ ] make a note in change log
17
+
18
+
Remember, you don't need to do it all yourself; any of these are helpful! 😎
19
+
6
20
## Issues
7
21
8
22
### Search open + closed issues for similar cases.
@@ -32,7 +46,11 @@ This is a helpful contribution all by itself. Thanks!
32
46
## PRs
33
47
34
48
If you would like to implement something, firstly: thanks! Community contributions
35
-
are a magical thing. Like Redux or the flux capacitor, they make open source possible.
49
+
are a magical thing. Like Redux or [the flux capacitor](https://youtu.be/SR5BfQ4rEqQ?t=2m25s),
50
+
they make open source possible.
51
+
52
+
**Working on your first Pull Request?**
53
+
You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
36
54
37
55
Here are some things to keep in mind when working on a PR:
38
56
@@ -50,7 +68,7 @@ jumping-off point for a core contributor or even another PR to continue what you
50
68
For enhancements to rules, please update the docs in `docs/rules` matching the rule
51
69
filename from `src/rules`.
52
70
53
-
Also, take a quick look at the rule summary in README.md in case it could use tweaking,
71
+
Also, take a quick look at the rule summary in [README.md] in case it could use tweaking,
54
72
or add a line if you've implemented a new rule.
55
73
56
74
Bugfixes may not warrant docs changes, though it's worth skimming the existing
@@ -66,19 +84,6 @@ Note also that the change log can't magically link back to Github entities (i.e.
66
84
issues, users) or rules; there are a handful of footnote URL definitions at the bottom.
67
85
You may need to add one or more URL if you've square-bracketed any such items.
68
86
69
-
## Checklist
70
-
71
-
-[ ] search open/closed issues
72
-
-[ ] discuss bug/enhancement in new or old issue
73
-
74
-
PR time:
75
-
-[ ] write tests
76
-
-[ ] implement feature/fix bug
77
-
-[ ] update docs
78
-
-[ ] make a note in change log
79
-
80
-
Remember, you don't need to do it all yourself; any of these are helpful! 😎
81
-
82
87
## Code of Conduct
83
88
84
89
This is not so much a set of guidelines as a reference for what I hope may become
@@ -107,3 +112,5 @@ If we can all get together behind the common goal of embracing empathy, everythi
107
112
108
113
Thanks for help from http://mozillascience.github.io/working-open-workshop/contributing/
0 commit comments