Contributing

CONTRIBUTING.rst

@@ -0,0 +1,49 @@
+.. |br| raw:: html
+
+   <br />
+
+############
+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**
+
+    .. 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**

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
-```