From b0e8a98c72edf2e78f13912cf7f399f8fbe3e475 Mon Sep 17 00:00:00 2001 From: Akmal Soliev Date: Mon, 27 Jan 2025 14:05:27 +0100 Subject: [PATCH] DOCS: Clearer contribution guidelines --- docs/contributing/CONTRIBUTING.md | 40 +++++++++++++------------------ 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md index 0a7a120..5db854d 100644 --- a/docs/contributing/CONTRIBUTING.md +++ b/docs/contributing/CONTRIBUTING.md @@ -5,45 +5,37 @@ on contribution to this project is wild for me, so I appreciate every minute you ## How to Contribute -1. Fork the repository on GitHub. -2. Clone your fork to your local machine: +1. Fork the repository on GitHub and clone your fork to your local machine: ```sh git clone https://github.com/your-username/Validoopsie.git ``` -3. Create a new branch for your feature or bugfix: +1. Install the required dependencies (I prefer using `uv` for this): + ```sh + uv sync --all-extras + ``` +If you want to modify the documentation, you will also need to install the documentation dependencies: + ```sh + uv sync --group docs + ``` + +2. Create a new branch for your feature or bugfix: ```sh git checkout -b my-feature-branch ``` -4. Make your changes in the new branch. -5. Run the tests to ensure that your changes do not break anything: +3. Make your changes in the new branch. +4. Run the tests to ensure that your changes do not break anything: ```sh pytest ``` -6. Commit your changes with a descriptive commit message: +5. Commit your changes with a descriptive commit message: ```sh git commit -m "Add feature X" ``` -7. Push your branch to your fork on GitHub: +6. Push your branch to your fork on GitHub: ```sh git push origin my-feature-branch ``` -8. Open a pull request on the main repository. - -## Setting Up the Development Environment - -1. Ensure you have Python 3.9 or higher installed. -2. Install the required dependencies (I prefer using `uv` for this): - ```sh - uv sync --all-extras - ``` - -## Running Tests - -We use `pytest` for running tests. To run the tests, execute the following command: -```sh -pytest -``` - +7. Open a pull request on the main repository. ## Submitting Changes