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

Improve PR template to encourage appropriate context in descriptions #4815

Closed

Conversation

alice-i-cecile
Copy link
Member

@alice-i-cecile alice-i-cecile commented May 20, 2022

Objective

  • the existing PR template was repetitive
    • merge Objective and Solution sections
    • remove Changelog section
  • the existing PR template often caused contributors to open PRs without adequate context
    • add a section on Context, with additional prompts for useful information
  • the PR template did not make clear that authors should call out the areas that are tricky or controversial in their PR description
    • add a Feedback Wanted section

Context

Feedback wanted

  1. Do you have any other ideas on ways we can encourage contributors to add more helpful context to their PRs?
  2. Is there a clearer way to mark sections as optional?
  3. Does this appropriately balance ease-of-making-a-PR with ease-of-reviewing-PRs?
  4. Are there any sections that can be safely cut? Can I make this even shorter?

@alice-i-cecile alice-i-cecile added A-Meta About the project itself X-Controversial There is active debate or serious implications around merging this PR labels May 20, 2022
@DJMcNab
Copy link
Member

DJMcNab commented May 20, 2022

This doesn't follow the current PR template :)

@MrGVSV
Copy link
Member

MrGVSV commented May 20, 2022

While fixing up the templates again, is it worth turning the suggestions into HTML comments? This would allow contributors to keep each suggestion so they don't miss anything and have something to reference.

But maybe that's just overkill/not as readable 😅

@alice-i-cecile
Copy link
Member Author

But maybe that's just overkill/not as readable 😅

I think the readability argument is critical here: most of the tools (like Github's PR tool or Gitkraken) won't render the HTML as you're editing, which makes that style of changes relatively confusing to users.

@alice-i-cecile alice-i-cecile added the C-Usability A simple quality-of-life change that makes Bevy easier to use label May 20, 2022
@mockersf
Copy link
Member

This is the size of the box when opening a PR:
Screenshot 2022-05-20 at 21 48 50

In my opinion, everything that is out of this box is too much

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
alice-i-cecile and others added 2 commits May 20, 2022 15:54
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>
Co-authored-by: François <mockersf@gmail.com>
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
Copy link
Member

@Vrixyz Vrixyz left a comment

Choose a reason for hiding this comment

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

Mostly minor nitpicks

.github/pull_request_template.md Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
alice-i-cecile and others added 3 commits May 30, 2022 14:18
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Co-authored-by: Thierry Berger <contact@thierryberger.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Meta About the project itself C-Usability A simple quality-of-life change that makes Bevy easier to use X-Controversial There is active debate or serious implications around merging this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants