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

Introduce a PR template based on Bevy's #5567

Closed
wants to merge 1 commit into from

Conversation

kirawi
Copy link
Member

@kirawi kirawi commented Jan 18, 2023

Objective

Solution

  • Copied Bevy's PR format. It's simple and can also be used to automate changelogs.

@kirawi kirawi added the S-waiting-on-review Status: Awaiting review from a maintainer. label Jan 18, 2023
@kirawi kirawi requested a review from archseer January 18, 2023 15:57
Copy link
Member

@pascalkuthe pascalkuthe left a comment

Choose a reason for hiding this comment

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

I like this template 👍 I am not a fan of most PR templates because the tend to get in the way and are too static. This just provides a bit of structure that will make PRs a bit more uniform and easier too read without being too daunting.

We might want to introsucte a second template for trivia changes which just asks for a short description. With trivia changes I mean:

  • documentation (typo fixes)
  • theme changes
  • langugue support (adding/changing tree sitter crammer or quieres or an LS)

@kirawi
Copy link
Member Author

kirawi commented Jan 19, 2023

Perhaps that could be a follow up PR?

@pascalkuthe
Copy link
Member

discussed this with @the-mikedavis I don't think we want contributors to add changelog entries. The rest of the template doesn't quite carry its weight.

We definitely want to expand the contributing.md and potentially add maybe pr templates for common tasks/review comments we make. I think it will need to be more tailored to our project (like one template for adding a new ts grammar/updating queries).

@pascalkuthe pascalkuthe closed this Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from a maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a PR template to help improve ease of reviewing
2 participants