From 8ffe437f54b0f0830c5f8eaf0bf09d417ed09638 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 19 Dec 2024 14:23:49 +0100 Subject: [PATCH] Add issue and pr templates #1 --- .github/ISSUE_TEMPLATE/issue_template_bug.md | 33 +++++++++++++++++ .../ISSUE_TEMPLATE/issue_template_feature.md | 19 ++++++++++ .../ISSUE_TEMPLATE/issue_template_release.md | 36 +++++++++++++++++++ .../issue_template_user_kudos.md | 22 ++++++++++++ .github/pull_request_template.md | 35 ++++++++++++++++++ 5 files changed, 145 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/ISSUE_TEMPLATE/issue_template_release.md create mode 100644 .github/ISSUE_TEMPLATE/issue_template_user_kudos.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..3e12d52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template_bug.md @@ -0,0 +1,33 @@ +--- +name: Bug Issue +about: For bugs and errors +title: Your title should make sense if said after "The issue is " +labels: ["status: active :construction:", "type: bug :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/OpenEnergyPlatform/OpenTransportOntology/blob/production/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..cb75f8b --- /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: ["status: active :construction:", "type: feature :hammer_and_wrench:"] +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/OpenEnergyPlatform/OpenTransportOntology/blob/production/CONTRIBUTING.md) diff --git a/.github/ISSUE_TEMPLATE/issue_template_release.md b/.github/ISSUE_TEMPLATE/issue_template_release.md new file mode 100644 index 0000000..115cf4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template_release.md @@ -0,0 +1,36 @@ +--- +name: Release Issue +about: For a new release +title: Release - Minor Version - 0.1.0 +labels: + [ + "priority: critical :fire:", + "status: active :construction:", + "type: release :rocket:", + "part: github :octocat:", + ] +assignees: "Ludee" +--- + +## Description of the release + +Describe the release in as much detail as possible. + +## Details of the release + +**Name:** Find an appropriate and memorable name for the release that will help it be remembered. +**Git tag:** v0.1.0 "super-repo Minor Release v0.1.0" +**Release Manager:** Choose a responsible person. +**Date:** Arrange a convenient date + +## Workflow checklist + +- [ ] I am aware of the workflow in [RELEASE_PROCEDURE.md](https://github.com/OpenEnergyPlatform/OpenTransportOntology//blob/production/RELEASE_PROCEDURE.md) +- [ ] 4. 🐙 Create a `Draft GitHub Release` +- [ ] 5. 💠 Create a `release` branch +- [ ] 6. 📝 Update the version files (CHANGELOG.md, CITATION.cff) +- [ ] 7. 🐙 Create a Release Pull Request +- [ ] 8. 💠 Set the `Git Tag` +- [ ] 9. 🐙 Publish `GitHub Release` +- [ ] 10. 💻 Update the documentation +- [ ] 11. 🐙 Set up new development diff --git a/.github/ISSUE_TEMPLATE/issue_template_user_kudos.md b/.github/ISSUE_TEMPLATE/issue_template_user_kudos.md new file mode 100644 index 0000000..37423cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template_user_kudos.md @@ -0,0 +1,22 @@ +--- +name: User Kudos Issue +about: User Community - Give kudos to the project +title: Add new user to USERS.cff +labels: + [ + "other: good first issue :seedling:", + "priority: low :sloth:", + "type: enhancement :gear:", + "part: community :earth_africa:", + ] +assignees: "" +--- + +I thank the developers of the project.
+Please add my information to the file [USERS.cff](https://github.com/OpenEnergyPlatform/OpenTransportOntology/blob/production/USERS.cff). + +family-names: +given-names: +alias: +affiliation: +orcid: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e6175b1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## 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/) + +### Changed + +- 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 + +Part of # / Closes # + +### PR-Assignee + +- [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md) +- [ ] 📝 Update the [CHANGELOG.md](https://github.com/rl-institut/super-repo/blob/develop/CHANGELOG.md) +- [ ] 📙 Update the documentation +- [ ] 🐙 Assign a reviewer to the PR + +### Reviewer + +- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md#40-let-someone-else-review-your-pr) +- [ ] 🐙 Provided feedback and show sufficient appreciation for the work done