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
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,8 @@ We use github to host code, to track issues and feature requests, as well as acc
14
14
15
15
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16
16
17
-
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
17
+
Pull requests are the best way to propose changes to the codebase (we use
18
+
[Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
18
19
19
20
1. Fork the repo and create your branch from `master`.
20
21
2. If you've added code that should be tested, add tests.
@@ -25,22 +26,27 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
25
26
26
27
## Any contributions you make will be under the MIT Software License
27
28
28
-
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29
+
In short, when you submit code changes, your submissions are understood to be under the same
30
+
[MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if
31
+
that's a concern.
29
32
30
33
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
31
34
32
35
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
33
36
34
37
## Write bug reports with detail, background, and sample code
35
38
36
-
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
39
+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad
40
+
model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I
41
+
greatly respect.
37
42
38
43
**Great Bug Reports** tend to have:
39
44
40
45
- A quick summary and/or background
41
46
- Steps to reproduce
42
47
- Be specific!
43
-
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce what I was seeing
48
+
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample
49
+
code that _anyone_ with a base R setup can run to reproduce what I was seeing
44
50
- What you expected would happen
45
51
- What actually happens
46
52
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
@@ -49,7 +55,8 @@ People _love_ thorough bug reports. I'm not even kidding.
49
55
50
56
## Use a Consistent Coding Style
51
57
52
-
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
- You can try running `npm run lint` for style unification
@@ -60,4 +67,5 @@ By contributing, you agree that your contributions will be licensed under its MI
60
67
61
68
## References
62
69
63
-
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
70
+
This document was adapted from the open-source contribution guidelines for
0 commit comments