Skip to content

Commit 73557cd

Browse files
committed
Minor doc improvment
1 parent 757eec8 commit 73557cd

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@ Feel free to use the IDE you love. Here come configurations for some popular IDE
2929

3030
```jsonc
3131
{
32-
"python.pythonPath": ".venv/bin/python",
32+
"python.defaultInterpreterPath": ".venv/bin/python",
3333
// Editor
34+
"editor.bracketPairColorization.enabled": true,
35+
"editor.guides.bracketPairs":"active",
3436
"editor.rulers": [
3537
88
3638
],
@@ -51,9 +53,16 @@ Feel free to use the IDE you love. Here come configurations for some popular IDE
5153
"--verbose"
5254
],
5355
"python.linting.pylintEnabled": false,
56+
// Tests
57+
"python.testing.pytestArgs": [],
58+
"python.testing.unittestEnabled": false,
59+
"python.testing.pytestEnabled": true,
5460
// Git
5561
"git.enableCommitSigning": true,
5662
// Extensions
57-
"autoDocstring.docstringFormat": "sphinx"
63+
"autoDocstring.docstringFormat": "sphinx",
64+
"yaml.schemas": {
65+
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs*.yml"
66+
}
5867
}
5968
```

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,9 @@ python -m pip install -U -r requirements/documentation.txt
8282
```
8383

8484
Then follow the [contribution guidelines](CONTRIBUTING.md).
85+
86+
## Release workflow
87+
88+
1. Fill the `CHANGELOG.md`
89+
2. Apply a git tag with the relevant version: `git tag -a 0.3.0 {git commit hash} -m "New awesome feature"`
90+
3. Push tag to main branch: `git push origin 0.3.0`

0 commit comments

Comments
 (0)