jgaunt/unifi-protect-backup
1
0
Fork 0
mirror of https://github.com/ep1cman/unifi-protect-backup.git synced 2025-12-15 15:53:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added clarifications to contribution guide

Browse Source 
- Remove mention od docs since those were removed
- Clarified how to run the application via poetry
This commit is contained in:
Sebastian Goscik
2022-02-22 23:34:32 +00:00
parent e56a38b73f
commit 48042aee04
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@@ -59,7 +59,8 @@ Ready to contribute? Here's how to set up `unifi-protect-backup` for local devel
4. Install dependencies and start your virtualenv: 4. Install dependencies and start your virtualenv:
``` ```
$ poetry install -E test -E doc -E dev $ poetry install -E test -E dev
$ poetry shell
``` ```
5. Create a branch for local development: 5. Create a branch for local development:
@@ -70,14 +71,21 @@ Ready to contribute? Here's how to set up `unifi-protect-backup` for local devel
Now you can make your changes locally. Now you can make your changes locally.
6. When you're done making changes, check that your changes pass the 6. To run `unifi-protect-backup` while developing you will need to either
be inside the `poetry shell` virtualenv or run it via poetry:
```
$ poetry run unifi-protect-backup {args}
```
7. When you're done making changes, check that your changes pass the
tests, including testing other Python versions, with tox: tests, including testing other Python versions, with tox:
``` ```
$ poetry run tox $ poetry run tox
``` ```
7. Commit your changes and push your branch to GitHub: 8. Commit your changes and push your branch to GitHub:
``` ```
$ git add . $ git add .
@@ -85,7 +93,7 @@ Ready to contribute? Here's how to set up `unifi-protect-backup` for local devel
$ git push origin name-of-your-bugfix-or-feature $ git push origin name-of-your-bugfix-or-feature
``` ```
8. Submit a pull request through the GitHub website. 9. Submit a pull request through the GitHub website.
## Pull Request Guidelines ## Pull Request Guidelines
@@ -93,8 +101,8 @@ Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests. 1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put 2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the your new functionality into a function with a docstring. If adding a CLI
feature to the list in README.md. option, you should update the "usage" in README.md.
3. The pull request should work for Python 3.9. Check 3. The pull request should work for Python 3.9. Check
https://github.com/ep1cman/unifi-protect-backup/actions https://github.com/ep1cman/unifi-protect-backup/actions
and make sure that the tests pass for all supported Python versions. and make sure that the tests pass for all supported Python versions.
@@ -120,4 +128,5 @@ $ git push
$ git push --tags $ git push --tags
``` ```
GitHub Actions will then deploy to PyPI if tests pass. GitHub Actions will then deploy to PyPI, produce a GitHub release, and a container
build if tests pass.