Skip to content

Commit

Permalink
chore(docs): CONTRIBUTING.md improved [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoDelatte committed Feb 3, 2024
1 parent 51a91b6 commit 8955fed
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Ready to contribute? Here's how to set yourself up for local development.
3. Install the project in development mode with the tests and linting dependencies:

```shell
$ pip install --editable '.[tests]'
$ pip install --editable ".[tests]"
```

4. Create a branch for local development:
Expand All @@ -61,7 +61,7 @@ Ready to contribute? Here's how to set yourself up for local development.

To name your branch, you can use the convention:
`category/reference/description-in-kebab-case`
with category: `feat`, `fix`, `refactor`, `chore` and reference:
with category: `feature`, `fix`, `refactor`, `chore` and reference:
`issue-<issue number>` or `no-ref`. For example: `feature/issue-34/factor-model`


Expand All @@ -74,10 +74,18 @@ Ready to contribute? Here's how to set yourself up for local development.
6. Then run linting checks with :

```shell
$ ruff
$ ruff check
```

7. Commit your changes and push your branch to GitHub:
7. If you added some documentation, you should test that it builds correctly :

```shell
$ pip install --editable ".[docs]"
$ cd docs
$ make html
```

8. Commit your changes and push your branch to GitHub:

```shell
$ git add .
Expand All @@ -87,12 +95,14 @@ Ready to contribute? Here's how to set yourself up for local development.

Note: the commit message should follow [the conventional commits](https://www.conventionalcommits.org).

8. Submit a pull request through the GitHub website or using the GitHub CLI:

9. Submit a pull request through the GitHub website or using the GitHub CLI:

```shell
$ gh pr create --fill
```


## Pull Request Guidelines

We like to have the pull request open as soon as possible, that's a great place to discuss any piece of work, even unfinished. You can use draft pull request if it's still a work in progress. Here are a few guidelines to follow:
Expand Down

0 comments on commit 8955fed

Please sign in to comment.