generated from aicoe-aiops/project-template
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chore: Minor documentation formatting updates
Signed-off-by: Matthew Watkins <[email protected]>
- Loading branch information
1 parent
966a22e
commit b3eb94b
Showing
5 changed files
with
32 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# Bug Reporting | ||
|
||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# Feature Requests | ||
|
||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
## Related Issues and Dependencies | ||
# Related Issues and Dependencies | ||
|
||
… | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,19 +4,15 @@ | |
|
||
To get set up, clone and enter the repo. | ||
|
||
``` | ||
git clone [email protected]:os-climate/physrisk.git | ||
cd physrisk | ||
``` | ||
git clone [email protected]:os-climate/physrisk.git | ||
cd physrisk | ||
|
||
We recommend using [pipenv](https://pipenv.pypa.io/en/latest/) for a | ||
consistent working environment. | ||
|
||
``` | ||
pip install pipenv | ||
pipenv install | ||
pipenv shell | ||
``` | ||
pip install pipenv | ||
pipenv install | ||
pipenv shell | ||
|
||
When adding a package for use in new or improved functionality, | ||
`pipenv install <package-name>`. Or, when adding something helpful for | ||
|
@@ -35,33 +31,27 @@ checks. | |
and enabling automatic formatting via [pre-commit](https://pre-commit.com/) | ||
is recommended: | ||
|
||
``` | ||
pre-commit install | ||
``` | ||
pre-commit install | ||
|
||
To ensure compliance with static check tools, developers may wish to run black and isort against modified files. | ||
|
||
E.g., | ||
|
||
``` | ||
# auto-sort imports | ||
isort . | ||
# auto-format code | ||
black . | ||
``` | ||
# auto-sort imports | ||
isort . | ||
# auto-format code | ||
black . | ||
|
||
Code can then be tested using tox. | ||
|
||
``` | ||
# run static checks and unit tests | ||
tox | ||
# run only tests | ||
tox -e py3 | ||
# run only static checks | ||
tox -e static | ||
# run unit tests and produce an HTML code coverage report (/htmlcov) | ||
tox -e cov | ||
``` | ||
# run static checks and unit tests | ||
tox | ||
# run only tests | ||
tox -e py3 | ||
# run only static checks | ||
tox -e static | ||
# run unit tests and produce an HTML code coverage report (/htmlcov) | ||
tox -e cov | ||
|
||
## IDE set-up | ||
|
||
|
@@ -75,10 +65,8 @@ Actions are configured to release to PyPI on pushing a tag. In order to do this: | |
- Update VERSION | ||
- Create new annotated tag and push | ||
|
||
``` | ||
git tag -a v1.0.0 -m "v1.0.0" | ||
git push --follow-tags | ||
``` | ||
git tag -a v1.0.0 -m "v1.0.0" | ||
git push --follow-tags | ||
|
||
## Forking workflow | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters