diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72d295ba..b811e53c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ], @@ -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" + } } ``` diff --git a/README.md b/README.md index de21d33d..29cd839c 100644 --- a/README.md +++ b/README.md @@ -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`