Added CONTRIBUTING.md

Author: Cubix1729

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing to LogicalPy
+
+The project welcomes any type of contribution.
+This document provides guidelines concerning how to contribute to LogicalPy.
+
+## How to make contributions
+
+### 1. Fork the project
+
+First, fork the project in GitHub.
+Then, you can clone your forked repository to your local computer:
+
+```
+git clone https://github.com/<your-username>/logicalpy.git
+cd logicalpy
+```
+
+### 2. Set up your development environment
+
+In order to contribute to the project, you will need to install it locally.
+
+ - You can first optionally create a virtual environment
+ - Then, locally install the project in editable mode with:
+    ```
+    pip install -e .
+    ```
+
+### 3. Make and commit your changes
+
+Once your are ready, create a new branch, make your changes and commit them with
+descriptive messages (preferably use the past tence).
+
+### 4. Create a pull request
+
+After pushing your changes to your forked repository, create a pull request to the
+`master` branch of the original repository. Provide a clear explanation of what you have done,
+as well as any relevant context.
+
+### 5. Review and merge
+
+Your pull request will then be reviewed, and once it has been approved, it will be
+merged to the main project 🎉.
+
+## Code style and testing guidelines
+
+To meet the project's code style, please format the code with `black` using the command
+`black <path-to-the-code>`. (The maximum line length used is the default one, i.e. 88 
+characters).
+
+If you implement any new feature or change an existing one, please update the tests in
+consequence.
+
+For any modification you make, ensure the tests still pass by running (from the main folder
+or from the `tests` folder):
+
+```
+python -m unittest
+```
+
+## Opening an issue
+
+If you find a bug or issue in the project, please [open an issue](https://github.com/Cubix1729/logicalpy/issues/new)
+to report it. Be sure to include:
+
+ - A clear description of the bug
+ - How to reproduce it
+ - Expected and actual behaviour
+ - The error message if there is one
+ - The LogicalPy version used and your environment setup
+
+You can also open an issue if you want to suggest a feature or if you have a question.
+
+## Thank you
+
+Thank you for your interest in contributing to LogicalPy!
+
+Happy propositional logic and programming! 🤓👨‍💻

README.md

@@ -34,13 +34,9 @@ Note that the library needs a Python version higher than 3.9.
 
 ## Contributing
 
-If you want to contribute to this (small) project, you can [open an issue](https://github.com/Cubix1729/logicalpy/issues)
-to report a bug or request a feature, or [make a pull request](https://github.com/Cubix1729/logicalpy/pulls).
-
-## Tests
-
-To run the the tests, first clone the repository, go into the `logicalpy` directory and locally install the project with `pip install -e .`
-Then, go into the `tests` directory and run `python -m unittest`.
+If you want to contribute to this project, you can open an issue to report a bug or request a feature,
+or make a pull request.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines.
 
 ## License
 

docs/index.md

@@ -38,13 +38,9 @@ For a complete project reference, see the [API Reference](api-reference/logicalp
 
 ## Contributing
 
-If you want to contribute to this (small) project, you can [open an issue](https://github.com/Cubix1729/logicalpy/issues)
-to report a bug or request a feature, or [make a pull request](https://github.com/Cubix1729/logicalpy/pulls).
-
-## Tests
-
-To run the the tests, first clone the repository, go into the `logicalpy` directory and locally install the project with `pip install -e .`
-Then, go into the `tests` directory and run `python -m unittest`.
+If you want to contribute to this project, you can open an issue to report a bug or request a feature,
+or make a pull request.
+See [CONTRIBUTING.md](https://github.com/Cubix1729/logicalpy/blob/master/CONTRIBUTING.md) for detailed contribution guidelines.
 
 ## License