From 0b3767cb901d184d645e1c62582c77463f922e53 Mon Sep 17 00:00:00 2001 From: steull Date: Wed, 8 Feb 2023 14:34:24 +0100 Subject: [PATCH] Template files added #90 --- .github/ISSUE_TEMPLATE/issue_template_bug.md | 31 +++++++++++++++++++ .../ISSUE_TEMPLATE/issue_template_feature.md | 19 ++++++++++++ .github/pull_request_template.md | 29 +++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue_template_bug.md create mode 100644 .github/ISSUE_TEMPLATE/issue_template_feature.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/issue_template_bug.md b/.github/ISSUE_TEMPLATE/issue_template_bug.md new file mode 100644 index 0000000..b15724e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template_bug.md @@ -0,0 +1,31 @@ +--- +name: Bug Issue +about: For bugs and errors +title: Your title should make sense if said after "The issue is " +labels: "bug" +assignees: '' + +--- + +## Description of the issue + +Describe the problem in as much detail as possible. +Focus on the expected and current behavior. +If necessary, create a screenshot and insert below. + +## Steps to Reproduce +1. +2. +3. + +## Ideas of solution + +Describe possible ideas for solution and evaluate advantages and disadvantages. + +## Context and Environment +* Version used: +* Operating system: +* Environment setup and (python) version: + +## Workflow checklist +- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md) diff --git a/.github/ISSUE_TEMPLATE/issue_template_feature.md b/.github/ISSUE_TEMPLATE/issue_template_feature.md new file mode 100644 index 0000000..200861f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template_feature.md @@ -0,0 +1,19 @@ +--- +name: Feature Issue +about: For new ideas, developments and features +title: Your title should make sense if said after "The issue is " +labels: "enhancement" +assignees: '' + +--- + +## Description of the issue + +Describe the problem in as much detail as possible. + +## Ideas of solution + +Describe possible ideas for solution and evaluate advantages and disadvantages. + +## Workflow checklist +- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..42b42c3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## Summary of the discussion + +Describe the findings of the discussion in the issue or meeting. + +## Type of change (CHANGELOG.md) + +### Added +- Add a new class [(#)](https://github.com/rl-institut/super-repo/pull/) + +### Updated +- Update a definition [(#)](https://github.com/rl-institut/super-repo/pull/) + +### Removed +- Remove a broken link [(#)](https://github.com/rl-institut/super-repo/pull/) + + +## Workflow checklist + +### Automation +Closes # + +### PR-Assignee +- [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md) +- [ ] 📝 Update the [CHANGELOG.md](https://github.com/rl-institut/super-repo/blob/develop/CHANGELOG.md) +- [ ] 📙 Update the documentation + +### Reviewer +- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md#40-let-someone-else-review-your-pr) +- [ ] 🐙 Provided feedback and show sufficient appreciation for the work done