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: README.md
+50
Original file line number
Diff line number
Diff line change
@@ -11,5 +11,55 @@ Just like that. You are in.
11
11
## Who are we?
12
12
13
13
## Contributing guidlines
14
+
We love your input! We want to make contributing to our projects as easy and transparent as possible, whether it's:
15
+
16
+
- Reporting a bug
17
+
- Discussing the current state of the code
18
+
- Submitting a fix
19
+
- Proposing new features
20
+
- Becoming a maintainer
21
+
22
+
### We Develop with Github
23
+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
24
+
25
+
### We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
26
+
Pull requests are the best way to propose changes to any codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
27
+
28
+
1. Fork the repo and create your branch from `master`.
29
+
2. If you've added code that should be tested, add tests.
30
+
3. If you've changed APIs, update the documentation.
31
+
4. Ensure the test suite/checks pass.
32
+
5. Make sure your code lints.
33
+
6. Issue that pull request!
34
+
35
+
### Any contributions you make will be under the licence of the repo you are contributing to
36
+
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.
37
+
38
+
### Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
39
+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
40
+
41
+
### Write bug reports with detail, background, and sample code
42
+
[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.
43
+
44
+
**Great Bug Reports** tend to have:
45
+
46
+
- A quick summary and/or background
47
+
- Steps to reproduce
48
+
- Be specific!
49
+
- 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
50
+
- What you expected would happen
51
+
- What actually happens
52
+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
53
+
54
+
People *love* thorough bug reports. I'm not even kidding.
55
+
56
+
### Use a Consistent Coding Style
57
+
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
58
+
59
+
* 2 spaces for indentation rather than tabs
60
+
* You can try running `npm run lint` for style unification
61
+
62
+
### License
63
+
By contributing, you agree that your contributions will be licensed under its License.
0 commit comments