-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: updated CONTRIBUTING.md to reflect collaboration strategy
- Loading branch information
1 parent
eb6c022
commit 1fb7dda
Showing
1 changed file
with
73 additions
and
47 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,60 @@ | ||
| # Contributing | ||
|
|
||
| Contributions are welcome, and they are greatly appreciated! Every little bit | ||
| helps, and credit will always be given. | ||
| `sharpedge` is an open source project, and we welcome contributions of all kinds: | ||
| new lessons, fixes to existing material, bug reports, | ||
| and reviews of proposed changes are all welcome. | ||
|
|
||
| ## Types of Contributions | ||
| ### Contributor Agreement | ||
|
|
||
| ### Report Bugs | ||
| By contributing, you agree that we may redistribute your work under | ||
| [our license](./LICENSE). In exchange, we will address your issues and/or assess | ||
| your change proposal as promptly as we can. | ||
| Please note that by contributing to this project, | ||
| you agree to abide by our [code of conduct](./CONDUCT.md). | ||
|
|
||
| If you are reporting a bug, please include: | ||
| ### How to Contribute | ||
|
|
||
| * Your operating system name and version. | ||
| * Any details about your local setup that might be helpful in troubleshooting. | ||
| * Detailed steps to reproduce the bug. | ||
| The easiest way to get started is to file an issue to tell us about a spelling | ||
| mistake, some awkward wording, or a factual error. This is a good way to | ||
| introduce yourself and to meet some of our community members. | ||
|
|
||
| ### Fix Bugs | ||
| 1. If you do not have a [GitHub][github] account, you can [send us comments by | ||
| email][contact]. However, we will be able to respond more quickly if you use | ||
| one of the other methods described below. | ||
|
|
||
| Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
| wanted" is open to whoever wants to implement it. | ||
| 2. If you have a [GitHub][github] account, or are willing to [create | ||
| one][github-join], but do not know how to use Git, you can report problems | ||
| or suggest improvements by [creating an issue][new_issues]. This allows us to | ||
| assign the item to someone and to respond to it in a threaded discussion. | ||
|
|
||
| ### Implement Features | ||
| 3. If you are comfortable with Git, and would like to add or change material, | ||
| you can submit a pull request (PR). Instructions for doing this are | ||
| [included below](#using-github). | ||
|
|
||
| Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
| and "help wanted" is open to whoever wants to implement it. | ||
| ### Using GitHub | ||
|
|
||
| ### Write Documentation | ||
| If you choose to contribute via GitHub, you may want to look at [How to | ||
| Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we | ||
| use [GitHub flow][github-flow] to manage changes: | ||
|
|
||
| You can never have enough documentation! Please feel free to contribute to any | ||
| part of the documentation, such as the official docs, docstrings, or even | ||
| on the web in blog posts, articles, and such. | ||
| 1. Create a new branch in your desktop copy of this repository for each | ||
| significant change. | ||
| 2. Commit the change in that branch. | ||
| 3. Push that branch to your fork of this repository on GitHub. | ||
| 4. Submit a [pull request][pull-request] from that branch to the [upstream repository][repo]. | ||
| Please tag an administrator as a reviewer to ensure your PR is reviewed promptly. | ||
| 5. If you receive feedback, make changes on your desktop and push to your | ||
| branch on GitHub: the pull request will update automatically. | ||
|
|
||
| ### What to Contribute | ||
|
|
||
| There are many ways to contribute, from implementing new features and improving | ||
| existing ones to updating or filling in the documentation and submitting [bug | ||
| reports][issues] or fixing bugs about things that do not work, are not clear, or are missing. | ||
|
|
||
| ### Submit Feedback | ||
| ### Contribution Guidelines | ||
|
|
||
| #### Implement Feature | ||
|
|
||
| If you are proposing a feature: | ||
|
|
||
|
|
@@ -38,36 +63,37 @@ If you are proposing a feature: | |
| * Remember that this is a volunteer-driven project, and that contributions | ||
| are welcome :) | ||
|
|
||
| ## Get Started! | ||
|
|
||
| Ready to contribute? Here's how to set up `sharpedge` for local development. | ||
|
|
||
| 1. Download a copy of `sharpedge` locally. | ||
| 2. Install `sharpedge` using `poetry`: | ||
| #### Report Bugs | ||
|
|
||
| ```console | ||
| $ poetry install | ||
| ``` | ||
|
|
||
| 3. Use `git` (or similar) to create a branch for local development and make your changes: | ||
|
|
||
| ```console | ||
| $ git checkout -b name-of-your-bugfix-or-feature | ||
| ``` | ||
|
|
||
| 4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests. | ||
|
|
||
| 5. Commit your changes and open a pull request. | ||
|
|
||
| ## Pull Request Guidelines | ||
| If you are reporting a bug, please include: | ||
|
|
||
| Before you submit a pull request, check that it meets these guidelines: | ||
| * Your operating system name and version. | ||
| * Any details about your local setup that might be helpful in troubleshooting. | ||
| * Detailed steps to reproduce the bug. | ||
|
|
||
| 1. The pull request should include additional tests if appropriate. | ||
| 2. If the pull request adds functionality, the docs should be updated. | ||
| 3. The pull request should work for all currently supported operating systems and versions of Python. | ||
| #### Write Documentation | ||
|
|
||
| ## Code of Conduct | ||
| You can never have enough documentation! Please feel free to contribute to any | ||
| part of the documentation, such as the official docs, docstrings, or even | ||
| on the web in blog posts, articles, and such. | ||
|
|
||
| Please note that the `sharpedge` project is released with a | ||
| Code of Conduct. By contributing to this project you agree to abide by its terms. | ||
| ### What *Not* to Contribute | ||
|
|
||
| We are not looking for exercises or materials that only run on one | ||
| platform. Our package typically contains a mixture of Windows, macOS, and | ||
| Linux users; in order to be usable, our package must run equally well on all | ||
| three. | ||
|
|
||
| ### Attribution | ||
| This Code of Conduct is inspired by [Software Carpentry CONTRIBUTING.md][attribution]. | ||
|
|
||
| [attribution]: https://github.com/swcarpentry/r-novice-inflammation/blob/main/CONTRIBUTING.md | ||
| [contact]: mailto:[email protected] | ||
| [github]: https://github.com | ||
| [github-flow]: https://guides.github.com/introduction/flow/ | ||
| [github-join]: https://github.com/join | ||
| [how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github | ||
| [issues]: https://github.com/UBC-MDS/SharpEdge/issues | ||
| [new_issues]: https://github.com/UBC-MDS/SharpEdge/issues/new | ||
| [pull-request]: https://help.github.com/en/articles/creating-a-pull-request | ||
| [repo]: https://github.com/UBC-MDS/SharpEdge | ||