Skip to content

Commit

Permalink
Edit readme and contributing
Browse files Browse the repository at this point in the history
Signed-off-by: Nicola Sella <[email protected]>
  • Loading branch information
inknos committed Aug 19, 2024
1 parent c71b22e commit 95f565b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,10 @@ Please don't include any private/sensitive information in your issue!

## Tools we use

- Python 3.6
- Python >= 3.6
- [pylint](https://www.pylint.org/)
- [black](https://github.com/psf/black)
- [tox](https://tox.readthedocs.io/en/latest/)
- You may need to use [virtualenv](https://virtualenv.pypa.io/en/latest/) to
support Python 3.6

## Testing
Expand All @@ -41,7 +40,7 @@ Integration tests would be required for large changes (TBD).
Run unit tests and get coverage report:

```
pip install tox
hatch shell
tox -e coverage
```

Expand All @@ -65,9 +64,11 @@ tox -e coverage

## Coding conventions

- Use [black](https://github.com/psf/black) code formatter. If you have tox
installed, run `tox -e black` to see what changes will be made. You can use
`tox -e black-format` to update the code formatting prior to committing.
- Formatting and linting are incorporated using [ruff](https://docs.astral.sh/ruff/).
- If you use [pre-commit](https://pre-commit.com/) the checks will run automatically
when you commit some changes
- If you prefer to run the ckecks manually, use `tox -e fix` to run the
pre-commit checks for you.
- Pass pylint
- exceptions are possible, but you will need to make a good argument
- Use spaces not tabs for indentation
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ It is currently under development and contributors are welcome!

## Dependencies

* For runtime dependencies, see [requirements.txt](https://github.com/containers/podman-py/blob/main/requirements.txt).
* For testing and development dependencies, see [test-requirements.txt](https://github.com/containers/podman-py/blob/main/test-requirements.txt).
* Runtime dependencies are specified in [pyproject.toml](https://github.com/containers/podman-py/blob/main/pyproject.toml).
* Testing dependencies can be installed via `pip install -e .[test]`

## Example usage

Expand Down

0 comments on commit 95f565b

Please sign in to comment.