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

PR and Issue templates #178

Merged
merged 4 commits into from
Aug 19, 2024
Merged

PR and Issue templates #178

merged 4 commits into from
Aug 19, 2024

Conversation

yardasol
Copy link
Contributor

This PR adds PR and Issue templates to the repo. They are similar to the ones i made for SaltProc but with some better formatting.

closes #130

@yardasol yardasol requested a review from katyhuff May 28, 2024 16:31
@yardasol
Copy link
Contributor Author

@katyhuff @smpark7 bump

@yardasol yardasol removed the request for review from gwenchee May 28, 2024 16:32
@smpark7
Copy link
Collaborator

smpark7 commented May 28, 2024

(Meta question) Do we want the templates to be strictly followed or to be general guidelines? I recognize the benefits of standardization since we welcome outside contributors, but I find the headers in the issue templates to be quite restrictive. I would prefer to have the Expected behavior, Describe the bug, and To reproduce headers be guidelines instead under one big section named Description.

As for the PR template, I think the checklist is good for reminding contributors (and ourselves) of our expectations.

@yardasol
Copy link
Contributor Author

@smpark7 great suggestions. Could you go ahead and suggest those changes so you can get commit credit for them?

Copy link
Member

@katyhuff katyhuff left a comment

Choose a reason for hiding this comment

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

This looks like a good addition. I have no problem with them as written. I see @smpark7 has made a suggestion and @yardasol has suggested that @smpark7 implement those suggested changes. For expediency, I recommend either the original PR author @yardasol incorporate those recommendations OR merging as is and allowing @smpark7 to make a separate PR with those changes sometime later.

@katyhuff
Copy link
Member

@yardasol @smpark7 Can you take a quick look at my final comment and decide what to do with this PR?

@smpark7
Copy link
Collaborator

smpark7 commented Aug 19, 2024

I'm okay with merging as is and refining the template later.

@katyhuff katyhuff merged commit 4ed4bce into arfc:devel Aug 19, 2024
@katyhuff
Copy link
Member

Thank you. Merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: completed
Status: completed
Development

Successfully merging this pull request may close these issues.

Create templates for issues and pull requests
3 participants