Skip to content

Commit

Permalink
Add issue and pr templates #1
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludee committed Dec 19, 2024
1 parent 63fe562 commit 8ffe437
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug Issue
about: For bugs and errors
title: Your title should make sense if said after "The issue is <your issue title>"
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)
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_feature.md
Original file line number Diff line number Diff line change
@@ -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 <your issue title>"
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)
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_release.md
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_user_kudos.md
Original file line number Diff line number Diff line change
@@ -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. <br>
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:
35 changes: 35 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8ffe437

Please sign in to comment.