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

Add small pr guidelines #2977

Merged
merged 6 commits into from
Oct 7, 2019
Merged

Conversation

tejal29
Copy link
Contributor

@tejal29 tejal29 commented Oct 3, 2019

Fixes #2812

Description
I this PR, add guidelines for keeping PRs small,

  1. for config changes
  2. Big feature requests.

User facing changes

  1. DEVELOPMENT.md links to writing small prs.

Next PRs.

  • How to keep your PRs small when Addressing bug fixes.
    Explain how one should address only one bug in a PR.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • [ n/a] Includes unit tests
  • [n/a ] Mentions any output changes.
  • [ X ] Adds documentation as needed: user docs, YAML reference, CLI reference.
  • [ n/a ] Adds integration tests if needed.

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

Reviewer Notes

  • The code flow looks good.
  • Unit test added.
  • User facing changes look good.

Release Notes

Describe any user facing changes here so maintainer can include it in the release notes, or delete this block.

Examples of user facing changes:
- Skaffold config changes like
  e.g. "Add buildArgs to `Kustomize` deployer skaffold config."
- Bug fixes
  e.g. "Improve skaffold init behaviour when tags are used in manifests"
- Any changes in skaffold behavior
  e.g. "Artiface cachine is turned on by default."

@codecov
Copy link

codecov bot commented Oct 3, 2019

Codecov Report

Merging #2977 into master will increase coverage by 0.12%.
The diff coverage is n/a.

Impacted Files Coverage Δ
pkg/skaffold/schema/versions.go 70.83% <0%> (-3.53%) ⬇️
pkg/skaffold/deploy/kubectl/visitor.go 93.75% <0%> (-0.37%) ⬇️
cmd/skaffold/app/cmd/cmd.go 68% <0%> (-0.26%) ⬇️
pkg/skaffold/kubernetes/context/context.go 100% <0%> (ø) ⬆️
pkg/skaffold/runner/runner.go 0% <0%> (ø) ⬆️
pkg/skaffold/server/endpoints.go 0% <0%> (ø) ⬆️
pkg/skaffold/schema/profiles.go 88.43% <0%> (+0.05%) ⬆️
pkg/skaffold/schema/defaults/defaults.go 91.08% <0%> (+0.05%) ⬆️
pkg/skaffold/event/event.go 92.21% <0%> (+0.19%) ⬆️
pkg/skaffold/runner/dev.go 67.96% <0%> (+0.31%) ⬆️
... and 5 more

docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
docs/community/small-prs.md Outdated Show resolved Hide resolved
balopat
balopat previously requested changes Oct 4, 2019
Copy link
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

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

This looks great, added grammar nits - plus I would add one more section somewhere :

Implementing the full functionality sometimes makes a lot of sense, so that you can get feedback regarding the design while implementing it, also, the maintainers can try it out and test it, get a feel for it. We can mark these "massive" PRs "prototype PR" or "master PR" that will broken down into smaller PRs that can refer back to the master PR. If you keep the master PR rebased as the smaller pieces get merged, finally the master PR can be merged as well. See for example #2917.

WDYT?

code review changes.

Co-Authored-By: Balint Pato <[email protected]>
@tejal29
Copy link
Contributor Author

tejal29 commented Oct 4, 2019

Implementing the full functionality sometimes makes a lot of sense, so that you can get feedback regarding the design while implementing it

We would want to encourage sending a design proposal for feedback on design or large changes. Having a design proposal does help to think about breaking down in smaller PRs since we have a section for it.
I thought i personally spent a lot of time rebasing my master PR i had for #2750 and just abandoned it. Nick also did the same thing with #2911

With that said, i do understand scenarios like this #2978
Do you think #2978, #2917, #2911 all could be an example of having a proposal?

I feel it might send conflicting messages but open for discussion.

@tejal29 tejal29 requested a review from balopat October 7, 2019 18:24
@tejal29 tejal29 dismissed balopat’s stale review October 7, 2019 19:46

addressed review comments as we discussed.

@tejal29 tejal29 merged commit 7e4612d into GoogleContainerTools:master Oct 7, 2019
@tejal29 tejal29 deleted the small_prs branch April 15, 2021 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TODO: Write up small PRs recommendations DEVELOPMENT.md
4 participants