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 template for issues #866

Merged
merged 6 commits into from
Jan 10, 2024
Merged

Add template for issues #866

merged 6 commits into from
Jan 10, 2024

Conversation

markpatton
Copy link
Contributor

@markpatton markpatton commented Jan 5, 2024

Create a template to provide standard information about issues.

The template cannot be tested in this repository until it is merged into main. But I've added it to another repository so it can be tested. See https://github.com/markpatton/dcs/issues.

Note that the formatting has been slightly altered from when it was first shown off.

@markpatton markpatton linked an issue Jan 5, 2024 that may be closed by this pull request
@markpatton markpatton requested a review from dkriethof January 5, 2024 19:02
Copy link
Contributor

@dkriethof dkriethof left a comment

Choose a reason for hiding this comment

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

Looks good to me! Let's share w/ the team before we merge, as you mentioned in Slack.

Copy link
Contributor

@bbranan bbranan left a comment

Choose a reason for hiding this comment

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

A few suggestions, mostly to clarify the template for those not already familiar with PASS.

.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/standard-issue.md Outdated Show resolved Hide resolved
@tsande16
Copy link
Contributor

tsande16 commented Jan 5, 2024

Should we have a section for directly related tickets? I know some of the tickets that I'm on, they get broken up into an analysis and implementation ticket. Perhaps it might be good to have a section where directly related tickets are listed? This would be an optional section of course, as not all tickets have a directly related ticket. So something along lines of:

Related tickets

  • Ticket123 is related because of xyz.
  • Ticket124 is related because of qed

@tsande16
Copy link
Contributor

tsande16 commented Jan 5, 2024

Overall looks good and it will be nice to have a ticket template! I agree with @bbranan suggestions. It makes sense to make the template as approachable as possible for those that are new to the development community.

@tsande16 tsande16 self-requested a review January 5, 2024 19:48
@markpatton
Copy link
Contributor Author

Checkboxes in prereqs to bullets.

@markpatton markpatton requested a review from dkriethof January 10, 2024 14:45
Copy link
Contributor

@dkriethof dkriethof left a comment

Choose a reason for hiding this comment

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

👍

@markpatton markpatton merged commit a7bf146 into main Jan 10, 2024
2 checks passed
@markpatton markpatton deleted the 865-issue-template branch January 10, 2024 15:12
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.

Create a ticket template in github
4 participants