- Notifications
You must be signed in to change notification settings - Fork145
Create CONTRIBUTING.md#491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for this - with a couple of changes, ready to go.
| ## 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| ##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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| ##Any contributions you make will be under the BSD2-Clause "Simplified" License | |
| ##Any contributions you make will be under the BSD3-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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| In short, when you submit code changes, your submissions are understood to be under the same[BSD2-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[BSD3-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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| - Give sample code if you can.[My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that*anyone* with a baseRsetup 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Clarify "I" again?
| ## 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| *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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| By contributing, you agree that your contributions will be licensed under its BSD2-Clause "Simplified" License. | |
| By contributing, you agree that your contributions will be licensed under its BSD3-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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| * You can try running`npm runlint` for style unification | |
| * You can try running`pre-commit run-a` for style unification (after`pip install pre-commit`). |
No description provided.