Skip to content

Improve issue templates #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krucod3 merged 1 commit into from
Oct 24, 2025
Merged

Improve issue templates #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,14 @@ assignees: ''
<!-- Before filling in the final result, summarize the use-case and/or workflow in a comment and discuss it with the committers -->

**To be filled by the one closing the issue.**

### Tasks

- [ ] Assign yourself as `assignee`;
- [ ] Fix the issue;
- [ ] Add a utest for this issue, if it's needed;
- [ ] Document the code similar to how it's done for the other code;
- [ ] Check and fix utests, coverage and lints; <!-- Check `run_checks.py` for how to run each tool -->
- [ ] Update documentation if needed; <!-- `docs/source` for the pages and objects in the scripts, `docs/Makefile` for generating and viewing the documentation -->
- [ ] Create Pull Request and fix possible workflow failures;
- [ ] Add the `ready_for_review` label.
17 changes: 7 additions & 10 deletions .github/ISSUE_TEMPLATE/enchancement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ assignees: ''
---

## Description

<!-- provide a description of the enhancement -->

## Goals

<!-- describe the goals you want to achieve with this enhancement -->

## Final result
Expand All @@ -24,11 +22,10 @@ assignees: ''

### Tasks

<!--
An optional lists of tasks that need to be executed
By using the list syntax ("[ ]"), github can track and visualize progress on the story.
-->

- [ ] Task 1
- [ ] Task 2
- [ ] ...
- [ ] Assign yourself as `assignee`;
- [ ] Implement enhancement;
- [ ] Document the code similar to how it's done for the other code;
- [ ] Check and fix utests, coverage and lints; <!-- Check run_checks.py for how to run each tool -->
- [ ] Update documentation if needed; <!-- docs/source for the pages and objects in the scripts, docs/Makefile for generating and viewing the documentation -->
- [ ] Create Pull Request and fix possible workflow failures;
- [ ] Add the `ready_for_review` label.