Skip to content

Commit ee06cff

Browse files
committed
CONTRIBUTING.md based on Metpy's guide
1 parent b8db9e0 commit ee06cff

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributors Guide
2+
3+
Are you interested in helping out?
4+
Have a few minutes to tackle an issue?
5+
In this guide we will get you setup into contributing to our project!
6+
7+
## Setting up your development environment
8+
9+
We recommend using the [conda](https://conda.io/docs/) package manager for your environments.
10+
Our recommended setup for contributing is:
11+
12+
1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html) on your system.
13+
You may have to restart your prompt for the remaining steps to work.
14+
15+
2. Now, with a local clone, of your fork\* you can create a development environment with:
16+
17+
```shell
18+
conda create --name MYENV python=3 --file requirements.txt --file requirements-dev.txt
19+
```
20+
21+
3. The changes should be made via GitHub pull requests\* against ``main``.
22+
23+
24+
## More Questions?
25+
26+
If you're stuck somewhere or are interested in being a part of the community in
27+
other ways, feel free to contact us!
28+
29+
## Further Reading
30+
31+
There are a ton of great resources out there on contributing to open source and on the
32+
importance of writing tested and maintainable software.
33+
34+
* [How to Contribute to Open Source Guide](https://opensource.guide/how-to-contribute/)
35+
* [Zen of Scientific Software Maintenance](https://jrleeman.github.io/ScientificSoftwareMaintenance/)
36+
37+
**Working on your first Pull Request?** You can learn how from this video series
38+
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github),
39+
Aaron Meurer's [tutorial on the git workflow](https://www.asmeurer.com/git-workflow/), or the
40+
guide [“How to Contribute to Open Source"](https://opensource.guide/how-to-contribute/).

0 commit comments

Comments
 (0)