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

github: introduce template for issues #1716

Merged
merged 4 commits into from
Mar 20, 2024
Merged

Conversation

bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Feb 20, 2024

Thank you for contributing to the Bareos Project!

This PR will introduce our first templates for creating issues on github.

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted

Copy link
Contributor

@sebsura sebsura left a comment

Choose a reason for hiding this comment

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

I added some comments.

.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
Comment on lines 37 to 42
description: What version of Bareos are you seeing the problem on?
options:
- 23x
- 24x
- Others
default: 0
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should set

multiple: true

here, since an issue might be possible on multiple different bareos issues.

Maybe we should also expand Others to 22,21,..., having at least all supported versions explicitly listed.

Copy link
Member

Choose a reason for hiding this comment

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

I'm not really happy with having numeric versions here at all. It will mean that we will have to change the template as part of every major release which adds yet another item to the release manager TODO list.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So the last idea would be to benefit of a direct link between an issues and the version to have this field as textarea fill'up by the user. That mean he can report component with mixed version and we will have the exact version including git and ~pre ....
I will propose another field for that.

.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
prove a divergence with the documentation, and/or a crash (trace) that are
somewhat reproducible.

We always recommend to start discussing your issue on the mailing list.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we also want to add something like

  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false

.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/20-feature_request.yaml Outdated Show resolved Hide resolved
@bruno-at-bareos bruno-at-bareos self-assigned this Mar 12, 2024
@bruno-at-bareos bruno-at-bareos added the documentation This PR changes only documentation label Mar 19, 2024
Copy link
Member

@arogge arogge left a comment

Choose a reason for hiding this comment

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

I think we're like 99% there already. Good work!

.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/10-issue_report.yaml Outdated Show resolved Hide resolved
Comment on lines 37 to 42
description: What version of Bareos are you seeing the problem on?
options:
- 23x
- 24x
- Others
default: 0
Copy link
Member

Choose a reason for hiding this comment

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

I'm not really happy with having numeric versions here at all. It will mean that we will have to change the template as part of every major release which adds yet another item to the release manager TODO list.

.github/ISSUE_TEMPLATE/20-feature_request.yaml Outdated Show resolved Hide resolved
.github/workflows/no-response.yaml Outdated Show resolved Hide resolved
tigerfoot and others added 3 commits March 20, 2024 16:37
- add ISSUE_TEMPLATE/config.yaml
- add ISSUE_TEMPLATE/10-issue_report.yaml for bugs
- add ISSUE_TEMPLATE/20-feature_request.yaml for feature
- add workflows/no-response.yaml no-response action

- we don't do line wrap so they will adapt to github rendering page
- we use labels of predefined defaults: beside `needs triage`,
  we prefill with `bug` or `enhancement` as it is easier to remove
  a label than adding one
- we use `render: sh` for log,trace textareas so there's no need
  to use backtick syntax

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- reformat long lines
- remove contributing patches by email

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@BareosBot BareosBot merged commit eb9a9c9 into master Mar 20, 2024
@BareosBot BareosBot deleted the dev/bruno/github-issues branch March 20, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This PR changes only documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants