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

change: [M3-8429] - Add a "Sizing a pull request" section to CONTRIBUTING.md #10764

Conversation

mjac0bs
Copy link
Contributor

@mjac0bs mjac0bs commented Aug 8, 2024

Description 📝

This is an action item from Cafe. (8/8/24)

Some good internal guidelines exist about writing good, small PRs. It would be useful for these to live in our public developer docs too, for ease of referencing and linking in PR reviews.

Changes 🔄

  • Adds the 'Sizing a pull request' section to our contributing docs page
  • Links that section in the 'Submitting a pull request' section

Preview 📷

Screenshot 2024-08-08 at 1 34 12 PM

How to test 🧪

Verification steps

(How to verify changes)

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@mjac0bs mjac0bs added the Documentation Improving / adding to our documentation label Aug 8, 2024
@mjac0bs mjac0bs self-assigned this Aug 8, 2024
@mjac0bs mjac0bs requested a review from a team as a code owner August 8, 2024 20:42
@mjac0bs mjac0bs requested review from bnussman-akamai and carrillo-erik and removed request for a team August 8, 2024 20:42
Copy link
Contributor

@jdamore-linode jdamore-linode left a comment

Choose a reason for hiding this comment

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

Thanks @mjac0bs!

Copy link
Member

@bnussman-akamai bnussman-akamai 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 🙏

Copy link

github-actions bot commented Aug 8, 2024

Coverage Report:
Base Coverage: 82.41%
Current Coverage: 82.41%

@mjac0bs mjac0bs merged commit 954cba7 into linode:develop Aug 9, 2024
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improving / adding to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants