Skip to content

Commit ae8823d

Browse files
authored
Update CONTRIBUTING.md (aws#285)
1 parent 9551d3a commit ae8823d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,27 @@ GitHub provides additional document on [forking a repository](https://help.githu
4040
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4141

4242

43+
## Developing Tornasole
44+
To develop Tornasole on your machine, here are some tips:
45+
1. Uninstall all existing Tornasole installs:
46+
```
47+
pip uninstall tornasole
48+
```
49+
2. Clone a copy of Tornasole from source:
50+
```
51+
git clone https://github.com/awslabs/tornasole_core
52+
cd tornasole_core
53+
```
54+
3. Install Tornasole in `develop` mode:
55+
```
56+
python setup.py develop
57+
```
58+
4. Install git hooks for auto-formatting:
59+
```
60+
pip install pre-commit
61+
pre-commit install
62+
```
63+
4364
## Finding contributions to work on
4465
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/tornasole_core/labels/help%20wanted) issues is a great place to start.
4566

0 commit comments

Comments
 (0)