Skip to content

Commit d623d93

Browse files
committed
add: contributing guidelines added
1 parent 32c3e42 commit d623d93

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Contributing
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+
10+
.. code:: bash
11+
12+
$ git clone [email protected]:username/modAL.git
13+
14+
15+
3. Create a feature branch for the changes from the dev branch:
16+
17+
.. code:: bash
18+
19+
$ git checkout -b new-feature dev
20+
21+
22+
Make sure that you create your branch from ``dev``.
23+
24+
4. After you have finished implementing the feature, make sure that all the tests pass. The tests can be run as
25+
26+
.. code:: bash
27+
28+
$ python3 path-to-modAL-repo/tests/core_tests.py
29+
30+
5. Commit and push the changes.
31+
32+
.. code:: bash
33+
34+
$ git add modified_files
35+
$ git commit -m 'commit message explaning the changes briefly'
36+
$ git push origin new-feature3
37+
38+
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``.

docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Currently supported active learning strategies are
3131
content/overview/modAL-in-a-nutshell
3232
content/overview/Installation
3333
content/overview/Extending-modAL
34+
content/overview/Contributing
3435

3536
.. toctree::
3637
:maxdepth: 1

0 commit comments

Comments
 (0)