Create CONTRIBUTING.md #491
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ## Any contributions you make will be under the BSD 2-Clause "Simplified" License | ||
| In short, when you submit code changes, your submissions are understood to be under the same [BSD 2-Clause "Simplified" License] that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
|
||
| ## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) |
There was a problem hiding this comment.
Suggested change
| ## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) | |
| ## Report bugs using Github's [issues](https://github.com/nipy/nipy/issues) |
| ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests | ||
| 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: | ||
|
|
||
| 1. Fork the repo and create your branch from `master`. |
There was a problem hiding this comment.
Suggested change
| 1. Fork the repo and create your branch from `master`. | |
| 1. Fork the repo and create your branch from `main`. |
| 5. Make sure your code lints. | ||
| 6. Issue that pull request! | ||
|
|
||
| ## Any contributions you make will be under the BSD 2-Clause "Simplified" License |
There was a problem hiding this comment.
Suggested change
| ## Any contributions you make will be under the BSD 2-Clause "Simplified" License | |
| ## Any contributions you make will be under the BSD 3-Clause License |
| 6. Issue that pull request! | ||
|
|
||
| ## Any contributions you make will be under the BSD 2-Clause "Simplified" License | ||
| In short, when you submit code changes, your submissions are understood to be under the same [BSD 2-Clause "Simplified" License] that covers the project. Feel free to contact the maintainers if that's a concern. |
There was a problem hiding this comment.
Suggested change
| In short, when you submit code changes, your submissions are understood to be under the same [BSD 2-Clause "Simplified" License] that covers the project. Feel free to contact the maintainers if that's a concern. | |
| In short, when you submit code changes, your submissions are understood to be under the same [BSD 3-Clause License] that covers the project. Feel free to contact the maintainers if that's a concern. |
| We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! | ||
|
|
||
| ## Write bug reports with detail, background, and sample code | ||
| [This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report someone 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. |
There was a problem hiding this comment.
Who is "I" here? Maybe add your initials to clarify?
| - A quick summary and/or background | ||
| - Steps to reproduce | ||
| - Be specific! | ||
| - 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 |
There was a problem hiding this comment.
Suggested change
| - 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 | |
| - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base setup can run to reproduce what I was seeing |
| People *love* thorough bug reports. I'm not even kidding. | ||
|
|
||
| ## Use a Consistent Coding Style | ||
| I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) |
| ## Use a Consistent Coding Style | ||
| I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) | ||
|
|
||
| * 2 spaces for indentation rather than tabs |
There was a problem hiding this comment.
Suggested change
| * 2 spaces for indentation rather than tabs | |
| * 4 spaces for indentation rather than tabs |
| * You can try running `npm run lint` for style unification | ||
|
|
||
| ## License | ||
| By contributing, you agree that your contributions will be licensed under its BSD 2-Clause "Simplified" License. |
There was a problem hiding this comment.
Suggested change
| By contributing, you agree that your contributions will be licensed under its BSD 2-Clause "Simplified" License. | |
| By contributing, you agree that your contributions will be licensed under its BSD 3-Clause License. |
| I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) | ||
|
|
||
| * 2 spaces for indentation rather than tabs | ||
| * You can try running `npm run lint` for style unification |
There was a problem hiding this comment.
Suggested change
| * You can try running `npm run lint` for style unification | |
| * You can try running `pre-commit run -a` for style unification (after `pip install pre-commit`). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.