Add CONTRIBUTING.md (#229)
This commit is contained in:
31
CONTRIBUTING.md
Normal file
31
CONTRIBUTING.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Contributing to faster-whisper
|
||||
|
||||
Contributions are welcome! Here are some pointers to help you install the library for development and validate your changes before submitting a pull request.
|
||||
|
||||
## Install the library for development
|
||||
|
||||
We recommend installing the module in editable mode with the `dev` extra requirements:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/guillaumekln/faster-whisper.git
|
||||
cd faster-whisper/
|
||||
pip install -e .[dev]
|
||||
```
|
||||
|
||||
## Validate the changes before creating a pull request
|
||||
|
||||
1. Make sure the existing tests are still passing (and consider adding new tests as well!):
|
||||
|
||||
```bash
|
||||
pytest tests/
|
||||
```
|
||||
|
||||
2. Reformat and validate the code with the following tools:
|
||||
|
||||
```bash
|
||||
black .
|
||||
isort .
|
||||
flake8 .
|
||||
```
|
||||
|
||||
These steps are also run automatically in the CI when you open the pull request.
|
||||
Reference in New Issue
Block a user