Skip to content

Move the docs/contributing.rst contents to CONTRIBUTING.rst #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 76 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1 +1,76 @@
Please read the `Contributing <https://openapi-spec-validator.readthedocs.io/en/latest/contributing.html>`__ guidelines in the documentation site.
Contributing
============

Firstly, thank you all for taking the time to contribute.

The following section describes how you can contribute to the openapi-spec-validator project on GitHub.

Reporting bugs
--------------

Before you report
^^^^^^^^^^^^^^^^^

* Check whether your issue does not already exist in the `Issue tracker <https://github.com/python-openapi/openapi-spec-validator/issues>`__.
* Make sure it is not a support request or question better suited for `Discussion board <https://github.com/python-openapi/openapi-spec-validator/discussions>`__.

How to submit a report
^^^^^^^^^^^^^^^^^^^^^^

* Include clear title.
* Describe your runtime environment with exact versions you use.
* Describe the exact steps which reproduce the problem, including minimal code snippets.
* Describe the behavior you observed after following the steps, pasting console outputs.
* Describe expected behavior to see and why, including links to documentations.

Code contribution
-----------------

Prerequisites
^^^^^^^^^^^^^

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:

.. code-block:: console

poetry config virtualenvs.in-project true

Setup
^^^^^

To create a development environment and install the runtime and development dependencies, run:

.. code-block:: console

poetry install

Then enter the virtual environment created by Poetry:

.. code-block:: console

poetry shell

Static checks
^^^^^^^^^^^^^

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.

To turn on pre-commit checks for commit operations in git, enter:

.. code-block:: console

pre-commit install

To run all checks on your staged files, enter:

.. code-block:: console

pre-commit run

To run all checks on all files, enter:

.. code-block:: console

pre-commit run --all-files

Pre-commit check results are also attached to your PR through integration with Github Action.
77 changes: 1 addition & 76 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,76 +1 @@
Contributing
============

Firstly, thank you all for taking the time to contribute.

The following section describes how you can contribute to the openapi-spec-validator project on GitHub.

Reporting bugs
--------------

Before you report
^^^^^^^^^^^^^^^^^

* Check whether your issue does not already exist in the `Issue tracker <https://github.com/python-openapi/openapi-spec-validator/issues>`__.
* Make sure it is not a support request or question better suited for `Discussion board <https://github.com/python-openapi/openapi-spec-validator/discussions>`__.

How to submit a report
^^^^^^^^^^^^^^^^^^^^^^

* Include clear title.
* Describe your runtime environment with exact versions you use.
* Describe the exact steps which reproduce the problem, including minimal code snippets.
* Describe the behavior you observed after following the steps, pasting console outputs.
* Describe expected behavior to see and why, including links to documentations.

Code contribution
-----------------

Prerequisites
^^^^^^^^^^^^^

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:

.. code-block:: console

poetry config virtualenvs.in-project true

Setup
^^^^^

To create a development environment and install the runtime and development dependencies, run:

.. code-block:: console

poetry install

Then enter the virtual environment created by Poetry:

.. code-block:: console

poetry shell

Static checks
^^^^^^^^^^^^^

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.

To turn on pre-commit checks for commit operations in git, enter:

.. code-block:: console

pre-commit install

To run all checks on your staged files, enter:

.. code-block:: console

pre-commit run

To run all checks on all files, enter:

.. code-block:: console

pre-commit run --all-files

Pre-commit check results are also attached to your PR through integration with Github Action.
.. include:: ../CONTRIBUTING.rst
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy