Skip to content

Add issue templates and configure KeywordLabeler app #2

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# GitHub issue form. For more information see:
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

name: Report something is not working properly 🐛
description:
Use this if there is something that is not working properly. If you are not
sure or you need help making something work, please ask a question instead.
labels: priority:❓, type:bug
body:
- type: markdown
attributes:
value:
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Please tell us what happened that shouldn't have.
placeholder: What happened that shouldn't have.
validations:
required: true
- type: textarea
id: what-expected
attributes:
label: What did you expect instead?
description: Please tell us what did you expect to happen.
placeholder: What did you expect to happen.
validations:
required: true
- type: dropdown
id: version
attributes:
label: Affected version(s)
description:
Which version(s) have you tried and found this issue in? (if you see
this issue **not** happening on any version, please let us know in the
"Extra information").
multiple: true
options:
- I don't know (version:❓)
- An older version (version:old)
- v0.1.x (version:0.1.x)
validations:
required: true
- type: dropdown
id: part
attributes:
label: Affected part(s)
description:
Which parts of the repo are affected by this issue? Select all that
apply.
multiple: true
options:
- I don't know (part:❓)
- Documentation (part:docs)
- Unit, integration and performance tests (part:tests)
- Build script, CI, dependencies, etc. (part:tooling)
- Channels implementation (part:channels)
validations:
required: true
- type: textarea
id: extra
attributes:
label: Extra information
description:
Please write here any extra information you think it might be relevant,
e.g., if this didn't happened before, or if you suspect where the
problem might be.
placeholder: Any extra information you think it might be relevant.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# GitHub issue template chooser. For more information see:
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

blank_issues_enabled: true
contact_links:
- name: Ask a question ❓
url: https://github.com/frequenz-floss/frequenz-channels-python/discussions/new?category=support
about: Use this if you are not sure how to do something, have installation problems, etc.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# GitHub issue form. For more information see:
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

name: Request a feature or enhancement ✨
description: Use this if something is missing or could be done better or more easily.
labels: part:❓, priority:❓, type:enhancement
body:
- type: markdown
attributes:
value:
Thanks for taking the time to fill out this feature or enhancement
request!
- type: textarea
id: whats-needed
attributes:
label: What's needed?
description:
Please tell us what's missing or what could be done better or more easily.
placeholder: What's missing or what could be done better or more easily.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description:
Please tell us how you think the needs above can be fulfilled. Only
fill this field if it wasn't described above.
placeholder:
How do you think the needs above can be fulfilled. Only fill this field
if it wasn't described above.
- type: textarea
id: use-cases
attributes:
label: Use cases
description:
Please tell us about the main use cases you see for this new feature or
enhancement to help us understand more.
placeholder:
The main use cases you see for this new feature or enhancement to help
us understand more.
- type: textarea
id: alternatives
attributes:
label: Alternatives and workarounds
description:
Please tell us if you tried any alternatives or workarounds for these
use cases and how (un)useful they were.
placeholder:
Any alternatives or workarounds for these use cases and how (un)useful
they were.
- type: textarea
id: additional-context
attributes:
label: Additional context
description:
Please add any additional information here - screenshots, diagrams, etc.
placeholder: Any additional information here - screenshots, diagrams, etc.
22 changes: 22 additions & 0 deletions .github/keylabeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# KeywordLabeler app configuration. For more information check:
# https://github.com/ZeWaka/KeywordLabeler#readme

# Determines if we search the title (optional). Defaults to true.
matchTitle: true

# Determines if we search the body (optional). Defaults to true.
matchBody: true

# Determines if label matching is case sensitive (optional). Defaults to true.
caseSensitive: true

# Explicit keyword mappings to labels. Form of match:label. Required.
labelMappings:
"part:channels": "part:channels"
"part:docs": "part:docs"
"part:tests": "part:tests"
"part:tooling": "part:tooling"
"part:❓": "part:❓"
"version:0.1.x": "version:0.1.x"
"version:old": "version:old"
"version:❓": "version:❓"