Merge pull request #31 from craigerl/update_readme

Updated README with more workflow details
This commit is contained in:
Craig Lamparter 2021-01-10 08:23:53 -08:00 committed by GitHub
commit 5db3c8c9b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions

View File

@ -351,11 +351,18 @@ Workflow
While working aprsd, The workflow is as follows
* Edit code, save file
* checkout a new branch to work on
* git checkout -b mybranch
* Edit code
* run tox -epep8
* run tox -efmt
* run tox -p
* git commit ( This will run the pre-commit hooks which does checks too )
* Once you are done with all of your commits, then push up the branch to
github
* git push -u origin mybranch
* Create a pull request from your branch so github tests can run and we can do
a code review.
Release