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

chore: add base PR template #418

Merged
merged 2 commits into from
Dec 13, 2022
Merged

Conversation

zivkovicmilos
Copy link
Member

@zivkovicmilos zivkovicmilos commented Dec 13, 2022

Description

This PR adds a base PR template for future contributions, that should be discussed in detail by the team.
It streamlines the PR review process by providing relevant information in the PR at a glance.

The base template is relatively simple to fill out. For more detailed PR templates, users can utilize the detailed_pr_template.md, by appending the template=detailed_pr_template.md query parameter (GitHub guide).

Changes include

  • Bugfix (non-breaking change that solves an issue)
  • Hotfix (change that solves an urgent issue, and requires immediate attention)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (change that is not backwards-compatible and/or changes current functionality)

Checklist (for contributors)

  • I have assigned this PR to myself
  • I have added at least 1 reviewer
  • I have added the relevant labels
  • I have updated the official documentation
  • I have added sufficient documentation in code

Testing

  • I have tested this code with the official test suite
  • I have tested this code manually

Additional comments

Tagging @moul and @harry-hov for visibility, as I can't add you as reviewers yet on the PR directly.

@zivkovicmilos zivkovicmilos self-assigned this Dec 13, 2022
@zivkovicmilos zivkovicmilos changed the title Add base PR template [WIP] Add base PR template Dec 13, 2022
@zivkovicmilos
Copy link
Member Author

@moul @harry-hov

I've updated the PR to include a simplified version of the PR template that shouldn't slow users down, but that also asks the user to provide more context for the changes.

The detailed PR template is still preserved, and users can access it using the template=detailed_pr_template.md query param on the new PR page (currently, GitHub doesn't provide a simple template select like with issues, so this is the only workaround).

@zivkovicmilos zivkovicmilos changed the title [WIP] Add base PR template Add base PR template Dec 13, 2022
@moul moul changed the title Add base PR template chore: add base PR template Dec 13, 2022
@moul moul merged commit 24e20b7 into gnolang:master Dec 13, 2022
@zivkovicmilos zivkovicmilos deleted the feature/pr-template branch December 13, 2022 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

2 participants