Skip to content

Commit 5c1fcab

Browse files
authored
Merge pull request #10 from haileyajohnson/docs
update contribute guide
2 parents 17bb0bb + 1710287 commit 5c1fcab

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

docs/dev_guide/contribute.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
11
# Contributors guide
2-
- welcome contributions!
3-
- types of contributions
2+
Thank you for considering making a contribution to CDIPpy! We welcome all types on contributions, including:
3+
4+
- **new features**: do you have a cool workflow or product that uses CDIP? We'd love to see it!
5+
- **bug fixes**: have you found something that doesn't work? We'd love help fixing it!
6+
- **code cleanup**: some of this code is *really old*; if you have ideas for making if cleaner or more efficient, we want to hear them!
7+
- **documentation and examples**: we would love more examples of `cdippy` library usage
48

59
## Setting up your git workflow
10+
This project uses a fork-and-contribute workflow. You will need to make your [fork](https://github.com/cdipsw/CDIPpy/fork) of the repository to work in, and submit changes to CDIPpy via pull request. To set up your workflow, follow these instructions:
11+
12+
1. Fork the respository at [https://github.com/cdipsw/CDIPpy/fork](https://github.com/cdipsw/CDIPpy/fork)
13+
2. Clone the repository from your fork `git clone https://github.com/{your_github_username}/CDIPpy.git` - this will add your own fork as your `origin` remote repo. *Note: If you already have the main fork cloned, skip to the next step and follow instuctions to add your fork as another remote.*
14+
3. Add the main fork as another remote (or your fork, if you cloned from the main fork). This will allow you to pull latest code from the main fork, but push your own development to your own fork:
15+
```bash
16+
git add remote cdip https://github.com/{your_github_username}/CDIPpy.git
17+
git fetch cdip
18+
git remote -v
19+
```
20+
If this worked, the last command will show your fork as `origin` and CDIP's as `cdip` (or whatever you have named them, respectively).
621

722
## Making your changes
823

24+
925
### linting
26+
1027
### testing
28+
1129
### documenting
1230

1331
## Making your pull request
32+
Once you are satisfied with your changes (or just ready to get more eyes on them), open a pull request at: [https://github.com/cdipsw/CDIPpy/pulls](https://github.com/cdipsw/CDIPpy/pulls).
1433

1534

16-
## Get help
35+
## Get help
36+
If you have an idea but aren't sure how to implement it or would like others to weigh in, open an issue on GitHub at [https://github.com/cdipsw/CDIPpy/issues](https://github.com/cdipsw/CDIPpy/issues)!

0 commit comments

Comments
 (0)