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

Issue and pull request templates: should we have them? #80

Closed
francisfuzz opened this issue Sep 12, 2024 · 4 comments · Fixed by #91
Closed

Issue and pull request templates: should we have them? #80

francisfuzz opened this issue Sep 12, 2024 · 4 comments · Fixed by #91
Labels
documentation Improvements or additions to documentation released

Comments

@francisfuzz
Copy link
Collaborator

Summary

Straight from the docs:

With issue and pull request templates, you can customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository.

I'm not sure if there's an existing canon we can pull from in this organization or in the github organization, but maybe something to consider for the future? 🤔

@francisfuzz francisfuzz added the documentation Improvements or additions to documentation label Sep 12, 2024
@gr2m
Copy link
Collaborator

gr2m commented Sep 12, 2024

I feel it's a bit early for pull request templates, I think they can be a great help to help maintain a project, but cause friction for contributors, especially if they are not a good fit. If you would like to try, I'd start with something very minimal.

@francisfuzz
Copy link
Collaborator Author

Sure! How does this draft look/feel?

### What are you trying to accomplish?

### What approach did you choose and why?

### What should reviewers focus on?

@gr2m
Copy link
Collaborator

gr2m commented Sep 13, 2024

sounds like a great start 👍🏼 maybe we could add an HTML comment stating that these are just suggestions and contributors can change or remove headers if they don't fit their use case?

francisfuzz added a commit that referenced this issue Sep 17, 2024
@gr2m gr2m closed this as completed in #91 Sep 17, 2024
gr2m pushed a commit that referenced this issue Sep 17, 2024
### What are you trying to accomplish?

Closes #80

### What approach did you choose and why?

I followed what was written in
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
and opted for the simplest route by adding the template to `.github/`.

### What should reviewers focus on?

Correctness 😉
Copy link

🎉 This issue has been resolved in version 5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants