Skip to content

Commit 8306ab5

Browse files
committed
add: contributing guidelines
1 parent 7e77701 commit 8306ab5

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Contributing to modAL
2+
=====================
3+
4+
Contributions to modAL are very much welcome! If you would like to help in general, visit the Issues page, where you'll find bugs to be fixed, features to be implemented. If you have a concrete feature in mind, you can proceed as follows.
5+
6+
1. Open a new issue. This helps us to discuss your idea and makes sure that you are not working in parallel with other contributors.
7+
8+
2. Fork the modAL repository and clone your fork to your local machine:
9+
```bash
10+
$ git clone git@github.com:username/modAL.git
11+
```
12+
13+
3. Create a feature branch for the changes from the dev branch:
14+
```bash
15+
$ git checkout -b new-feature dev
16+
```
17+
Make sure that you create your branch from ```dev```.
18+
19+
4. After you have finished implementing the feature, make sure that all the tests pass. The tests can be run as
20+
```bash
21+
$ python3 path-to-modAL-repo/tests/core_tests.py
22+
```
23+
24+
5. Commit and push the changes.
25+
```bash
26+
$ git add modified_files
27+
$ git commit -m 'commit message explaning the changes briefly'
28+
$ git push origin new-feature
29+
```
30+
31+
6. Create a pull request from your fork **to the dev branch**. After the code is reviewed and possible issues are cleared, the pull request is merged to ```dev```.

0 commit comments

Comments
 (0)