Skip to content

Conversation

@Mikelle
Copy link
Contributor

@Mikelle Mikelle commented Jul 23, 2024

Added PR template. Benefits of having it:

  • Consistency: all PRs follows the same format, making them easier to review
  • Efficiency: guides contributors what to include, speeding up the PR creation
  • Thoroughness: Prompts for essential details like changes, testing, and impact, ensuring nothing is missed
  • Transparency: Encourages clear communication of changes, improving team transparency

@Mikelle Mikelle self-assigned this Jul 23, 2024

## Checklist before requesting a review

- [ ] I have performed a self-review of my code
Copy link
Contributor

@shaspitz shaspitz Jul 23, 2024

Choose a reason for hiding this comment

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

I'm good with this checklist if it's helpful to people and stays simple 👍 I just have a personal gripe with PR checklists because it got unnecessarily large at my last job and clearly slowed down the team.

My opinion is that the first point is implicit to any PR, and the rest should preferably be automated via ci (I believe we're close to automating the last point with infrastructure / Setup and Test Nomad Cluster? As that would save significant time for small changes)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your feedback! Sure, we can delete the first point if you think it’s redundant. I think we could remove the others once this will be automated. If any of the checkpoints are not required for the PR, they can simply be deleted.

@Mikelle Mikelle requested a review from shaspitz July 24, 2024 17:51
@Mikelle Mikelle merged commit 9529ee8 into main Jul 25, 2024
@Mikelle Mikelle deleted the feat/add-pr-template branch July 25, 2024 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants