Skip to content

Commit

Permalink
Minor doc improvment
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts committed Mar 31, 2022
1 parent 757eec8 commit 73557cd
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ Feel free to use the IDE you love. Here come configurations for some popular IDE

```jsonc
{
"python.pythonPath": ".venv/bin/python",
"python.defaultInterpreterPath": ".venv/bin/python",
// Editor
"editor.bracketPairColorization.enabled": true,
"editor.guides.bracketPairs":"active",
"editor.rulers": [
88
],
Expand All @@ -51,9 +53,16 @@ Feel free to use the IDE you love. Here come configurations for some popular IDE
"--verbose"
],
"python.linting.pylintEnabled": false,
// Tests
"python.testing.pytestArgs": [],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
// Git
"git.enableCommitSigning": true,
// Extensions
"autoDocstring.docstringFormat": "sphinx"
"autoDocstring.docstringFormat": "sphinx",
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs*.yml"
}
}
```
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,9 @@ python -m pip install -U -r requirements/documentation.txt
```

Then follow the [contribution guidelines](CONTRIBUTING.md).

## Release workflow

1. Fill the `CHANGELOG.md`
2. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "New awesome feature"`
3. Push tag to main branch: `git push origin 0.3.0`

0 comments on commit 73557cd

Please sign in to comment.