Skip to content

Commit

Permalink
DOCS: Clearer contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
akmalsoliev committed Jan 27, 2025
1 parent 6c9577a commit b0e8a98
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions docs/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b0e8a98

Please sign in to comment.