diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..409b610 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. ... +2. ... + +If possible, attach a minimal file that triggers the error. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Error message** +If applicable, add the error message to help explain your problem. + +**Please complete the following information:** + - Version: [Please fill in the version number] + - OS: [e.g. Windows, Linux, OS X] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..066b2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/refactoring.md b/.github/ISSUE_TEMPLATE/refactoring.md new file mode 100644 index 0000000..3abda76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactoring.md @@ -0,0 +1,11 @@ +--- +name: Refactoring (for developers) +about: Refactor the application + +--- + +**Describe the refactoring action** +A clear and concise description of what the action is. + +**Expected benefit** +A clear and concise description of what you expect to improve by the refactoring. diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md new file mode 100644 index 0000000..b139fe6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release.md @@ -0,0 +1,17 @@ +--- +name: Release +about: Create a new release of cassis + +--- + +**Checklist** + +- [ ] Make sure all issues for the milestone are completed, otherwise move them +- [ ] Checkout the `main` branch +- [ ] Bump the version in `cassis/__version__.py` to a stable one, e.g. `__version__ = "0.6.0"`, commit and push +- [ ] Check and wait that the build completed. +- [ ] Create a tag for that version and push it +- [ ] Wait for the build and Pypi to show the new version +- [ ] Bump the version to the next development version, commit and push that. +- [ ] Convert the tag to a release on Github, write release note based on issues in the respective milestone +- [ ] Create a new milestone