Skip to content

Commit 06f5f1b

Browse files
committed
Improve CONTRIBUTING
1 parent bbe99f3 commit 06f5f1b

File tree

1 file changed

+47
-38
lines changed

1 file changed

+47
-38
lines changed

CONTRIBUTING.rst

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ reports, improving documentation, submitting feature requests, reviewing
66
new submissions, or contributing code that can be incorporated into the
77
project.
88

9+
Review process
10+
--------------
11+
12+
For any **significant** changes please create a new GitHub issue and
13+
enhancements that you wish to make. Describe the feature you would like
14+
to see, why you need it, and how it will work. Discuss your ideas
15+
transparently and get community feedback before proceeding.
16+
17+
Small changes can directly be crafted and submitted to the GitHub
18+
Repository as a Pull Request. This requires creating a **repo fork** using
19+
`instruction <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_.
20+
21+
Important notes
22+
---------------
23+
24+
Please take into account that some companies still use old Python versions, like 3.7. So the changes should be compatible.
25+
926
Initial setup for local development
1027
-----------------------------------
1128

@@ -14,45 +31,31 @@ Install Git
1431

1532
Please follow `instruction <https://docs.github.com/en/get-started/quickstart/set-up-git>`_.
1633

17-
Create a fork
18-
~~~~~~~~~~~~~
19-
20-
If you are not a member of a development team building Evacuator, you should create a fork before making any changes.
21-
22-
Please follow `instruction <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_.
23-
2434
Clone the repo
2535
~~~~~~~~~~~~~~
2636

27-
Open terminal and run these commands:
37+
Open terminal and run these commands to clone a **forked** repo:
2838

2939
.. code:: bash
3040
3141
git clone git@github.com:myuser/evacuator.git -b develop
3242
3343
cd evacuator
3444
35-
Setup environment
36-
~~~~~~~~~~~~~~~~~
45+
Enable pre-commit hooks
46+
~~~~~~~~~~~~~~~~~~~~~~~
3747

3848
Create virtualenv and install dependencies:
3949

4050
.. code:: bash
4151
42-
# create virtual environment
4352
python -m venv venv
4453
source venv/bin/activate
4554
pip install -U wheel
4655
pip install -U pip setuptools
47-
48-
# install requirements
4956
pip install -U \
50-
-r requirements-dev.txt \
51-
-r requirements-docs.txt \
52-
-r requirements-test.txt
53-
54-
Enable pre-commit hooks
55-
~~~~~~~~~~~~~~~~~~~~~~~
57+
-r requirements.txt \
58+
-r requirements-dev.txt
5659
5760
Install pre-commit hooks:
5861

@@ -69,19 +72,36 @@ Test pre-commit hooks run:
6972
How to
7073
------
7174

72-
7375
Run tests
7476
~~~~~~~~~
7577

78+
.. note::
79+
80+
You can skip this if only source code behavior remains the same.
81+
82+
Create virtualenv and install dependencies:
83+
7684
.. code:: bash
7785
78-
# run tests
79-
pytest
86+
pip install -U -r requirements-test.txt
87+
88+
.. code:: bash
8089
90+
pytest
8191
8292
Build documentation
8393
~~~~~~~~~~~~~~~~~~~
8494

95+
.. note::
96+
97+
You can skip this if only source code behavior remains the same.
98+
99+
Create virtualenv and install dependencies:
100+
101+
.. code:: bash
102+
103+
pip install -U -r requirements-docs.txt
104+
85105
Build documentation using Sphinx:
86106

87107
.. code:: bash
@@ -92,21 +112,6 @@ Build documentation using Sphinx:
92112
Then open in browser ``docs/_build/index.html``.
93113

94114

95-
Review process
96-
--------------
97-
98-
Please create a new GitHub issue for any significant changes and
99-
enhancements that you wish to make. Provide the feature you would like
100-
to see, why you need it, and how it will work. Discuss your ideas
101-
transparently and get community feedback before proceeding.
102-
103-
Significant Changes that you wish to contribute to the project should be
104-
discussed first in a GitHub issue that clearly outlines the changes and
105-
benefits of the feature.
106-
107-
Small Changes can directly be crafted and submitted to the GitHub
108-
Repository as a Pull Request.
109-
110115
Create pull request
111116
~~~~~~~~~~~~~~~~~~~
112117

@@ -204,7 +209,11 @@ How to skip change notes check?
204209
Just add ``ci:skip-changelog`` label to pull request.
205210

206211
Release Process
207-
^^^^^^^^^^^^^^^
212+
---------------
213+
214+
.. note::
215+
216+
This is for repo maintainers only
208217

209218
Before making a release from the ``develop`` branch, follow these steps:
210219

0 commit comments

Comments
 (0)