mirror of https://github.com/pypa/hatch.git
68 lines
1.0 KiB
Markdown
68 lines
1.0 KiB
Markdown
# Contributing
|
|
|
|
The usual process to make a contribution is to:
|
|
|
|
1. Check for existing related issues
|
|
2. Fork the repository and create a new branch
|
|
3. Make your changes
|
|
4. Make sure formatting, linting and tests passes.
|
|
5. Add tests if possible to cover the lines you added.
|
|
6. Commit, and send a Pull Request.
|
|
|
|
## Clone the repository
|
|
|
|
Clone the `hatch` repository, `cd` into it, and create a new branch for your contribution:
|
|
|
|
```bash
|
|
cd hatch
|
|
git switch -c add-my-contribution
|
|
```
|
|
|
|
## Run the tests
|
|
|
|
Run the test suite while developing:
|
|
|
|
```bash
|
|
hatch test
|
|
```
|
|
|
|
Run the test suite with coverage report:
|
|
|
|
```bash
|
|
hatch test --cover
|
|
```
|
|
|
|
Run the extended test suite with coverage:
|
|
|
|
```bash
|
|
hatch test --cover --all
|
|
```
|
|
|
|
## Lint
|
|
|
|
Run automated formatting:
|
|
|
|
```bash
|
|
hatch fmt
|
|
```
|
|
|
|
Run full linting and type checking:
|
|
|
|
```bash
|
|
hatch fmt --check
|
|
hatch run types:check
|
|
```
|
|
|
|
## Docs
|
|
|
|
Start the documentation in development:
|
|
|
|
```bash
|
|
hatch run docs:serve
|
|
```
|
|
|
|
Build and validate the documentation website:
|
|
|
|
```bash
|
|
hatch run docs:build-check
|
|
``` |