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

Changes to pull_request_template.md for clarity and flow #5939

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

alison985
Copy link
Contributor

What are you changing in this pull request and why?

In #5938 I said that the style guide doc link in the pull request template didn't work and I'd open a separate pull request. I also couldn't find the style guide on the docs site under contributing, so I was looking in the wrong place. When I went to edit this file the links worked. 😆 at myself. I must have copied it wrong the first time.

However, the template did seem pieced together instead of cohesive, so I'm here proposing some changes.

  • Cut the line break that didn't match the method of the rest of the document.
  • Moved the checklist items that are relevant to al pull requests to the top of the list. I think this will help contributors understand which checklist items apply to them. Along with the other changes bulleted below it should make it so we don't have to read the entire list of items when submitting each PR in order to make sure we don't skip one.
  • Removed the duplicate checklist item about versioning under the pre-release version checklist items.
  • Changed the top line of each optional set of checklist items to be easy to find and clear about when to use it.
  • Changed the phrasing of the statements to make them more like certifications you've done the required activity. This matches the dbt-core pull request template.

I did not:

  • Add a note or reference to a Code of Conduct. I think COCs are vital, at the same time it may be something you don't want to add to this particular template to keep the "barriers" to doc contribution low.
  • Attempt to cross-link the Docs contribution guidelines with the dbt-docs style guide.

Checklist

@alison985 alison985 requested a review from a team as a code owner August 17, 2024 18:29
Copy link

vercel bot commented Aug 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Aug 29, 2024 0:03am

@github-actions github-actions bot added the size: small This change will take 1 to 2 days to address label Aug 17, 2024
Copy link
Contributor

@matthewshaver matthewshaver left a comment

Choose a reason for hiding this comment

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

Thank you @alison985 ! Very much appreciated

@matthewshaver
Copy link
Contributor

Add a note or reference to a Code of Conduct. I think COCs are vital, at the same time it may be something you don't want to add to this particular template to keep the "barriers" to doc contribution low.

Thanks for considering the COCs. We agree that they're essential, but yes, this page is meant as a quick reference to be linked from a broader guide that will include the COC information. As we don't really encounter folks disregarding the COC, I think it's ok to leave it out here.

Attempt to cross-link the Docs contribution guidelines with the dbt-docs style guide.

This is a good call and something we can take up on our side. Thank you!

@matthewshaver matthewshaver enabled auto-merge (squash) August 29, 2024 00:00
@matthewshaver matthewshaver merged commit 6b582c3 into dbt-labs:current Aug 29, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants