Skip to content
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.

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

doc: add GitHub issue templates #516

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

trueNAHO
Copy link
Collaborator

@trueNAHO trueNAHO commented Aug 20, 2024

Add GitHub issue templates to standardize issue formatting and reduce maintainer effort.

Closes: #268


Cc: @danth

Currently, this patch adds an issue template only for the bug label. Once the issue template format reaches a consensus, it can be extended to all the other labels. Later, we discuss adding and removing labels.

@trueNAHO trueNAHO marked this pull request as draft August 20, 2024 20:52
@trueNAHO trueNAHO mentioned this pull request Aug 20, 2024
2 tasks
trueNAHO added a commit to trueNAHO/stylix that referenced this pull request Aug 20, 2024
Add GitHub issue templates to standardize issue formating and reduce
maintainer effort.

Closes: danth#268
Link: danth#516
@trueNAHO trueNAHO force-pushed the doc-add-github-issue-templates branch from a0fb126 to 12445b6 Compare August 20, 2024 20:54
trueNAHO added a commit to trueNAHO/stylix that referenced this pull request Aug 20, 2024
Add GitHub issue templates to standardize issue formatting and reduce
maintainer effort.

Closes: danth#268
Link: danth#516
@trueNAHO trueNAHO force-pushed the doc-add-github-issue-templates branch from 12445b6 to e82fdb2 Compare August 20, 2024 21:18
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
Add GitHub issue templates to standardize issue formatting and reduce
maintainer effort.

Closes: danth#268
Link: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
Link: danth#516

Reviewed-by: Daniel Thwaites <[email protected]>
@trueNAHO trueNAHO force-pushed the doc-add-github-issue-templates branch from e82fdb2 to b7ffdc9 Compare August 21, 2024 22:36
@trueNAHO
Copy link
Collaborator Author

Changelog: v1

  • Commit Message
    • Add Link: tag to GitHub issue form documentation
    • Credit @danth as reviewer
  • Patch
    • Add installation method checkboxes
    • Add validations: required
    • Replace input version table with flake.lock content
    • Remove Description placeholder and update its description
    • Rename Bug Report to Bug
    • Rename .github/ISSUE_TEMPLATE/bug_report.yml file to .github/ISSUE_TEMPLATE/bug.yml

@trueNAHO trueNAHO requested a review from danth August 26, 2024 17:36

attributes:
description: >-
Describe the issue in detail. Consider including a minimal working
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bugs do not work by definition but can be reproduced:

Suggested change
Describe the issue in detail. Consider including a minimal working
Describe the issue in detail. Consider including a minimal reproducible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: add GitHub issue templates
2 participants