Skip to content

Commit

Permalink
Merge pull request #91 from OpenEnergyPlatform/feature-90-issue_and_p…
Browse files Browse the repository at this point in the history
…r_templates

 Issue and PR-Template
  • Loading branch information
jh-RLI authored Oct 25, 2024
2 parents db2fa04 + 0b3767c commit 008af79
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug Issue
about: For bugs and errors
title: Your title should make sense if said after "The issue is <your issue title>"
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)
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: "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)
29 changes: 29 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 008af79

Please sign in to comment.