File tree 1 file changed +22
-15
lines changed
1 file changed +22
-15
lines changed Original file line number Diff line number Diff line change 1
- # Contributing
1
+ # How to contribute
2
2
3
- ## Set up
3
+ ## Bug reports or feature requests
4
4
5
- - Clone the repo
6
- - Install [ anaconda-project ] ( https://anaconda.org/anaconda/anaconda-project )
5
+ [ Open an issue ] ( https://github.com/gtri/rapid-modeling-tools/issues ) with your bug report
6
+ or feature request.
7
7
8
- ### Make changes
9
- - Create an issue to accompany pull requests to describe changes.
8
+ ## Contributing code
10
9
11
- ## Code Quality
10
+ 1 . [ Create a fork ] ( https://github.com/gtri/rapid-modeling-tools/fork )
12
11
13
- Keep the style consistent
12
+ 1 . Get [ Miniconda ] ( https://conda.io/miniconda.html ) .
14
13
15
- ```
16
- anaconda-project run black
17
- ```
14
+ 1 . Get anaconda-project...
18
15
19
- Keep the coverage up by adding unit tests
16
+ $ conda install -n base anaconda-project
20
17
21
- ```
22
- anaconda-project run test
23
- ```
18
+ 1 . In the repo, run...
19
+
20
+ $ anaconda-project prepare
21
+ anaconda-project run setup
22
+
23
+ 1 . Keep the style consistent and the quality high by running Black and Pytest...
24
+
25
+ $ anaconda-project run black
26
+ $ anaconda-project run tests
27
+
28
+ 4 . Push a commit with a meaningful message to your own fork.
29
+
30
+ 5 . Submit a [ pull request] ( https://github.com/gtri/rapid-modeling-tools/compare ) . The PR should be tied to a GitHub issue.
24
31
25
32
## For Questions
26
33
You can’t perform that action at this time.
0 commit comments