From 26f3ef92886db737e9954ec84a49272036bc923c Mon Sep 17 00:00:00 2001 From: "Sergei V. Elfimov" Date: Thu, 19 Jun 2025 11:31:02 +0300 Subject: [PATCH 1/2] feat (readme): add CONTRIBUTING.rst --- CONTRIBUTING.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 ---------- 2 files changed, 44 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..59e0db6 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,44 @@ +.. |br| raw:: html + +
+ +############ +Contributing +############ + +Contributions are always welcome and appreciated! Here are some ways you can contribute. + +****** +Issues +****** + +You can and should open an issue for any of the following reasons: + +* you found a bug; steps for reproducing, or a pull request with a failing test case will be greatly appreciated +* you wanted to do something but did not find a way to do it after reading the documentation +* you believe the current way of doing something is more complicated or less elegant than it can be +* a related feature that you want is missing from the package + +Please always check for existing issues before opening a new issue. + +************* +Pull requests +************* + +You want to contribute some code? Great! Here are a few steps to get you started: + +#. **Fork the repository on GitHub** +#. **Clone your fork and create a branch for the code you want to add** +#. **Install the package in development mode** + +.. code:: console + + $ pip install poetry + $ poetry install + +#. **Make your changes and check** +#. **Update the tests if necessary** +#. **Run tests. The project is setup to use pytest for testing** +#. **Update documentation** +#. **Push your branch and submit a pull request to the main branch on GitHub** +#. **Your code must pass all the required CI jobs before it is merged** diff --git a/README.md b/README.md index 0b6aa6d..1237598 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,3 @@ This is a fork [fastapi-filter](https://github.com/arthurio/fastapi-filter) ## Installation ```pip install fastapi-filter-sqlalchemy``` - -## Contribution - -You can run tests with `pytest`. - -``` -pip install poetry -poetry install -pytest -``` From fd5c11fd4733d464f3ca35e587907fe75f91bf99 Mon Sep 17 00:00:00 2001 From: "Sergei V. Elfimov" Date: Thu, 19 Jun 2025 11:33:12 +0300 Subject: [PATCH 2/2] fix CONTRIBUTING.rst --- CONTRIBUTING.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 59e0db6..2d41653 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -31,14 +31,19 @@ You want to contribute some code? Great! Here are a few steps to get you started #. **Clone your fork and create a branch for the code you want to add** #. **Install the package in development mode** -.. code:: console + .. code:: console - $ pip install poetry - $ poetry install + $ pip install poetry + $ poetry install #. **Make your changes and check** #. **Update the tests if necessary** #. **Run tests. The project is setup to use pytest for testing** + + .. code:: console + + $ pytest + #. **Update documentation** #. **Push your branch and submit a pull request to the main branch on GitHub** #. **Your code must pass all the required CI jobs before it is merged**