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
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,10 @@ We love your input! We want to make contributing to this project as easy and tra
9
9
- Becoming a maintainer
10
10
11
11
## We Develop with Github
12
+
12
13
We use GitHub to host code, to track issues and feature requests, and to accept Pull Requests.
13
14
14
-
## Report Bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
15
+
## Report Bugs using Github's Issue Tracker
15
16
16
17
If you find bugs, mistakes, or inconsistencies in this project's code or documents, please let us know by [opening a new issue](./issues), but consider searching through existing issues first to check and see if the problem has already been reported. If it has, it never hurts to add a quick "+1" or "I have this problem too". This helps prioritize the most common problems and requests.
17
18
@@ -24,12 +25,12 @@ If you find bugs, mistakes, or inconsistencies in this project's code or documen
24
25
- A quick summary and/or background
25
26
- Steps to reproduce
26
27
- Be specific!
27
-
- Give sample code if you can. [The stackoverflow bug report](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
28
+
- Give sample code if you can. [The stackoverflow bug report](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce what I was seeing
28
29
- What you expected would happen
29
30
- What actually happens
30
31
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
31
32
32
-
People *love* thorough bug reports. I'm not even kidding.
33
+
People _love_ thorough bug reports. I'm not even kidding.
33
34
34
35
## Submit Code Changes through Pull Requests
35
36
@@ -39,9 +40,9 @@ We ask that more significant improvements to the project be first proposed befor
39
40
40
41
### Use a Consistent Coding Style
41
42
42
-
* We indent using two spaces (soft tabs)
43
-
* We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.
44
-
* This is open-source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
43
+
- We indent using two spaces (soft tabs)
44
+
- We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.
45
+
- This is open-source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
45
46
46
47
### Use [Github Flow](https://guides.github.com/introduction/flow/index.html) for Pull Requests
47
48
@@ -61,5 +62,6 @@ In short, when you submit code changes, your submissions are understood to be av
61
62
## References
62
63
63
64
Portions of this CONTRIBUTING.md document were adopted from best practices of a number of open source projects, including:
0 commit comments