-
Notifications
You must be signed in to change notification settings - Fork 112
Misc README updates #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
cd589ab
0c86ff6
1ddd597
1fd4276
dde1e3f
22bbd22
83c4753
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing | ||
|
||
To contribute to this repository, fork it and send pull requests. | ||
|
||
## Set up your environment | ||
|
||
This project uses [Poetry](https://python-poetry.org/) for dependency management, tests, and linting. | ||
|
||
1. Clone this respository | ||
2. Run `poetry install` | ||
|
||
### Unit Tests | ||
|
||
#### All tests | ||
```bash | ||
poetry run pytest tests | ||
``` | ||
|
||
#### Specific tests | ||
|
||
```bash | ||
poetry run pytest tests/path/to/test.py | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how can I run a specific test method from a test file? does poetry support that? (non blocking comment) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch. I added a more specific example in 22bbd22 |
||
``` | ||
|
||
### Code formatting | ||
|
||
This project uses [Black](https://pypi.org/project/black/). | ||
|
||
``` | ||
poetry run black src | ||
``` | ||
## Pull Request Process | ||
|
||
1. Update the [CHANGELOG.md](README.md) or similar documentation with details of changes you wish to make, if applicable. | ||
2. Add any appropriate tests. | ||
3. Make your code or other changes. | ||
4. Review guidelines such as | ||
[How to write the perfect pull request][github-perfect-pr], thanks! | ||
|
||
[github-perfect-pr]: https://blog.github.com/2015-01-21-how-to-write-the-perfect-pull-request/ |
Uh oh!
There was an error while loading. Please reload this page.