1
1
Thank you for your interest in contributing to Junction. We welcome all
2
2
contributions and greatly appreciate your effort!
3
3
4
- Bugs / Feature Requests
5
- -----------------------
4
+ Bugs and Features
5
+ -----------------
6
6
7
7
If you have found any bugs or would like to request a new feature, please do
8
8
check if there is an existing issue already filed for the same, in the
9
9
project's GitHub `issue tracker `_. If not, please file a new issue.
10
10
11
- Issue Workflow
12
- --------------
13
-
14
- Choose an issue from the `issue tracker `_ to work on and claim it by posting
15
- a comment saying "I would like to work on this.". Feel free to ask any doubts
16
- in the issue thread.
11
+ If you want to help out by fixing bugs, choose an issue from the `issue
12
+ tracker `_ to work on and claim it by posting a comment saying "I would like to
13
+ work on this.". Feel free to ask any doubts in the issue thread.
17
14
18
15
Once you have implemented the feature to an extent, go ahead and file a pull
19
- request, following the tips below. File a pull request early to get as much
20
- feedback early as possible.
16
+ request, following the tips below. File a pull request early to get feedback as
17
+ early as possible.
21
18
22
- Pull Requests Tips
23
- ------------------
19
+ Pull Requests
20
+ -------------
24
21
25
22
Pull Requests should be small to facilitate easier review. Keep them
26
23
self-contained, and limited in scope. Studies have shown that review quality
@@ -37,6 +34,10 @@ Checklist:
37
34
4. In case of UI changes, please include screenshots.
38
35
5. Add yourself to ``CONTRIBUTORS.txt `` if you're not there already. :)
39
36
37
+ If you do make any changes to models (modification or addition), make sure to
38
+ run ``python manage.py makemigrations `` to enable the server to migrate existing
39
+ data to the new models.
40
+
40
41
Code Convention
41
42
---------------
42
43
@@ -47,10 +48,6 @@ In general, if flake8 is happy with your code, you should be fine. To use
47
48
48
49
$ flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 <project_dir>/
49
50
50
- If you do make any changes to models (modification or addition), make sure to
51
- run ``python manage.py makemigrations `` to enable the server to migrate existing
52
- data to the new models.
53
-
54
51
.. _`issue tracker` : https://github.com/pythonindia/junction/issues
55
52
.. _`flake8` : https://flake8.readthedocs.org/en/latest/
56
53
.. _`Django Coding Style` : https://docs.djangoproject.com/en/2.2/internals/contributing/writing-code/coding-style/
0 commit comments