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

dx: Clean up PR template #8541

Merged
merged 6 commits into from
Nov 8, 2024
Merged

dx: Clean up PR template #8541

merged 6 commits into from
Nov 8, 2024

Conversation

Pwuts
Copy link
Member

@Pwuts Pwuts commented Nov 4, 2024

image

There is stuff in the PR template that is not template stuff. It should either be commented out so that it's only visible to the author/editor, or moved to the contribution guide. Or changed into a checklist so it can be used to communicate useful information about the PR, but the longer the template gets, the smaller the chance people will actually fill it out.

@Pwuts Pwuts requested a review from a team as a code owner November 4, 2024 17:15
@Pwuts Pwuts requested review from kcze, aarushik93 and Torantulino and removed request for a team November 4, 2024 17:15
Copy link
Contributor

github-actions bot commented Nov 4, 2024

This PR targets the master branch but does not come from dev or a hotfix/* branch.

Automatically setting the base branch to dev.

@github-actions github-actions bot added the platform/backend AutoGPT Platform - Back end label Nov 4, 2024
@github-actions github-actions bot changed the base branch from master to dev November 4, 2024 17:15
@github-actions github-actions bot added the size/m label Nov 4, 2024
Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit fb99768
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/672901278990070008d2ca39

@ntindle
Copy link
Member

ntindle commented Nov 5, 2024

IMO Add a test plan requirement

autogpt_platform/README.md Outdated Show resolved Hide resolved
@Pwuts
Copy link
Member Author

Pwuts commented Nov 5, 2024

@ntindle what do you mean exactly?

@ntindle
Copy link
Member

ntindle commented Nov 5, 2024

As one of the few reviewing PRs right now, it’s hard to know what things interact with and I need to test

@Pwuts
Copy link
Member Author

Pwuts commented Nov 5, 2024

@ntindle I get that, but what does that mean for this PR? What text do you want to have placed where?

@ntindle
Copy link
Member

ntindle commented Nov 5, 2024

Swap those sections to writing test plans

@ntindle
Copy link
Member

ntindle commented Nov 7, 2024

In looking back at this, tbh I like how it is

@Pwuts
Copy link
Member Author

Pwuts commented Nov 7, 2024

Reasons I don't like this stuff being in the PR template like it is now:

  • It's a lot of text, but not relevant for a significant fraction of PRs.
  • It doesn't provide any value to read it to anyone but the PR author.
  • It isn't a checklist, which would be a much more useful for something like this.
  • We're putting basic contribution instructions here, without pointing to any of our more elaborate contribution guides/instructions. This fragmentation isn't good for the contributor experience.

@ntindle
Copy link
Member

ntindle commented Nov 7, 2024

I think a better move would be converting it to a checklist and adding links to the areas you're discussing

@Pwuts Pwuts requested a review from ntindle November 8, 2024 14:27
@Pwuts Pwuts merged commit c960bd8 into dev Nov 8, 2024
9 checks passed
@Pwuts Pwuts deleted the reinier/clean-up-pr-template branch November 8, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform/backend AutoGPT Platform - Back end size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants