Skip to content

Commit 78ef3d2

Browse files
authored
Merge pull request #417 from kurtmckee/make-contributing-easier-to-access
Move the `docs/contributing.rst` contents to `CONTRIBUTING.rst`
2 parents 6f29484 + da5afa1 commit 78ef3d2

File tree

2 files changed

+77
-77
lines changed

2 files changed

+77
-77
lines changed

CONTRIBUTING.rst

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,76 @@
1-
Please read the `Contributing <https://openapi-spec-validator.readthedocs.io/en/latest/contributing.html>`__ guidelines in the documentation site.
1+
Contributing
2+
============
3+
4+
Firstly, thank you all for taking the time to contribute.
5+
6+
The following section describes how you can contribute to the openapi-spec-validator project on GitHub.
7+
8+
Reporting bugs
9+
--------------
10+
11+
Before you report
12+
^^^^^^^^^^^^^^^^^
13+
14+
* Check whether your issue does not already exist in the `Issue tracker <https://github.com/python-openapi/openapi-spec-validator/issues>`__.
15+
* Make sure it is not a support request or question better suited for `Discussion board <https://github.com/python-openapi/openapi-spec-validator/discussions>`__.
16+
17+
How to submit a report
18+
^^^^^^^^^^^^^^^^^^^^^^
19+
20+
* Include clear title.
21+
* Describe your runtime environment with exact versions you use.
22+
* Describe the exact steps which reproduce the problem, including minimal code snippets.
23+
* Describe the behavior you observed after following the steps, pasting console outputs.
24+
* Describe expected behavior to see and why, including links to documentations.
25+
26+
Code contribution
27+
-----------------
28+
29+
Prerequisites
30+
^^^^^^^^^^^^^
31+
32+
Install `Poetry <https://python-poetry.org>`__ by following the `official installation instructions <https://python-poetry.org/docs/#installation>`__. Optionally (but recommended), configure Poetry to create a virtual environment in a folder named ``.venv`` within the root directory of the project:
33+
34+
.. code-block:: console
35+
36+
poetry config virtualenvs.in-project true
37+
38+
Setup
39+
^^^^^
40+
41+
To create a development environment and install the runtime and development dependencies, run:
42+
43+
.. code-block:: console
44+
45+
poetry install
46+
47+
Then enter the virtual environment created by Poetry:
48+
49+
.. code-block:: console
50+
51+
poetry shell
52+
53+
Static checks
54+
^^^^^^^^^^^^^
55+
56+
The project uses static checks using fantastic `pre-commit <https://pre-commit.com/>`__. Every change is checked on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then run following command to install pre-commit.
57+
58+
To turn on pre-commit checks for commit operations in git, enter:
59+
60+
.. code-block:: console
61+
62+
pre-commit install
63+
64+
To run all checks on your staged files, enter:
65+
66+
.. code-block:: console
67+
68+
pre-commit run
69+
70+
To run all checks on all files, enter:
71+
72+
.. code-block:: console
73+
74+
pre-commit run --all-files
75+
76+
Pre-commit check results are also attached to your PR through integration with Github Action.

docs/contributing.rst

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1 @@
1-
Contributing
2-
============
3-
4-
Firstly, thank you all for taking the time to contribute.
5-
6-
The following section describes how you can contribute to the openapi-spec-validator project on GitHub.
7-
8-
Reporting bugs
9-
--------------
10-
11-
Before you report
12-
^^^^^^^^^^^^^^^^^
13-
14-
* Check whether your issue does not already exist in the `Issue tracker <https://github.com/python-openapi/openapi-spec-validator/issues>`__.
15-
* Make sure it is not a support request or question better suited for `Discussion board <https://github.com/python-openapi/openapi-spec-validator/discussions>`__.
16-
17-
How to submit a report
18-
^^^^^^^^^^^^^^^^^^^^^^
19-
20-
* Include clear title.
21-
* Describe your runtime environment with exact versions you use.
22-
* Describe the exact steps which reproduce the problem, including minimal code snippets.
23-
* Describe the behavior you observed after following the steps, pasting console outputs.
24-
* Describe expected behavior to see and why, including links to documentations.
25-
26-
Code contribution
27-
-----------------
28-
29-
Prerequisites
30-
^^^^^^^^^^^^^
31-
32-
Install `Poetry <https://python-poetry.org>`__ by following the `official installation instructions <https://python-poetry.org/docs/#installation>`__. Optionally (but recommended), configure Poetry to create a virtual environment in a folder named ``.venv`` within the root directory of the project:
33-
34-
.. code-block:: console
35-
36-
poetry config virtualenvs.in-project true
37-
38-
Setup
39-
^^^^^
40-
41-
To create a development environment and install the runtime and development dependencies, run:
42-
43-
.. code-block:: console
44-
45-
poetry install
46-
47-
Then enter the virtual environment created by Poetry:
48-
49-
.. code-block:: console
50-
51-
poetry shell
52-
53-
Static checks
54-
^^^^^^^^^^^^^
55-
56-
The project uses static checks using fantastic `pre-commit <https://pre-commit.com/>`__. Every change is checked on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then run following command to install pre-commit.
57-
58-
To turn on pre-commit checks for commit operations in git, enter:
59-
60-
.. code-block:: console
61-
62-
pre-commit install
63-
64-
To run all checks on your staged files, enter:
65-
66-
.. code-block:: console
67-
68-
pre-commit run
69-
70-
To run all checks on all files, enter:
71-
72-
.. code-block:: console
73-
74-
pre-commit run --all-files
75-
76-
Pre-commit check results are also attached to your PR through integration with Github Action.
1+
.. include:: ../CONTRIBUTING.rst

0 commit comments

Comments
 (0)