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

add issue and PR templates #909

Merged
merged 3 commits into from
Sep 10, 2024
Merged

Conversation

jmartin-tech
Copy link
Collaborator

@jmartin-tech jmartin-tech commented Sep 10, 2024

Fix #885

These templates crib heavily from other open-source repository tooling.

  • provide initial template PRs
  • provide various issue reporting options
  • add label triggers for some common queue maintenance tasks

Added label automation will require addition of the following labels:

  • needs-linting
  • needs-unique-branch
  • needs-testing-environment
  • needs-pull-request-template
  • needs-more-information

* provide initial template PRs
* provide various issue reporting options
* add label triggers for some common queue maintenance tasks

Signed-off-by: Jeffrey Martin <[email protected]>
@jmartin-tech
Copy link
Collaborator Author

Templates as offered for new issues - Note this order can be adjusted via filename prefixes:
Screenshot 2024-09-10 at 11 53 49 AM

PR prompted template:
Screenshot 2024-09-10 at 11 55 12 AM

Copy link
Collaborator

@leondz leondz left a comment

Choose a reason for hiding this comment

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

Minor changes, generally looks fine

issues:
types: [labeled]

jobs:
Copy link
Collaborator

Choose a reason for hiding this comment

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

what does the label automation do - does it respond to added labels, or does it add labels itself? guessing the latter

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This responds when a label is added. The posted message is attributed to the bot which then helps infer decision is objective and project based not just the opinion of the labeler.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note that only users with write permissions to the repo can add labels to existing issues or PRs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This label automation can be combined with other actions. In the past I have used these in combination with a scheduled action to add labels to aging issues that have not had any interaction and close out those items if no action is taken to move them forward within a predetermined period.

Copy link
Collaborator

Choose a reason for hiding this comment

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

this sounds great. i already have an action item to do this manually somewhere low on my todo.

Co-authored-by: Leon Derczynski <[email protected]>
Signed-off-by: Jeffrey Martin <[email protected]>
@leondz leondz merged commit 7a99261 into NVIDIA:main Sep 10, 2024
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 10, 2024
@jmartin-tech jmartin-tech deleted the feature/issue-templates branch September 10, 2024 20:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add github templates for issue reporting
2 participants