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.

Sign up for GitHub

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

Jump to bottom

Rewrite the "Container Contract" documentation for clarity and flow. #2914

Merged
merged 1 commit into from
Jul 15, 2020
Merged

Rewrite the "Container Contract" documentation for clarity and flow. #2914

merged 1 commit into from
Jul 15, 2020

Conversation

tualeron
Copy link
Contributor

@tualeron tualeron commented Jul 8, 2020 •
edited
Loading

Changes

Rewrites the "Container Contract" documentation for clarity and flow.

Submitter Checklist

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

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

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

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

 NONE

@tekton-robot tekton-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 8, 2020
@tekton-robot
Copy link
Collaborator

This PR cannot be merged: expecting exactly one kind/ label

Available kind/ labels are:

kind/question: Issues or PRs that are questions around the project or a particular feature
kind/bug: Categorizes issue or PR as related to a bug.
kind/flake: Categorizes issue or PR as related to a flakey test
kind/cleanup: Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/design: Categorizes issue or PR as related to design.
kind/documentation: Categorizes issue or PR as related to documentation.
kind/feature: Categorizes issue or PR as related to a new feature.
kind/misc: Categorizes issue or PR as a miscellaneuous one.

@pritidesai
Copy link
Member

pritidesai commented Jul 9, 2020 •
edited
Loading

/kind documentation

@sergetron please add the following release note section in the PR description ⬆️ if there are no release notes which is documented here:

Release Notes

NONE

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 9, 2020
@tualeron
Copy link
Contributor Author

tualeron commented Jul 9, 2020

/release-note-none

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jul 9, 2020
@vdemeester
Copy link
Member

@sergetron thanks for the PR. Few things that would be nice for future PRs:

  1. Using different names, or at least "categorize" them, here it could be "container-contract: improve …"
  2. Following the PR template would be super cool 🙃

@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 9, 2020
@tualeron
Copy link
Contributor Author

tualeron commented Jul 9, 2020

@sergetron thanks for the PR. Few things that would be nice for future PRs:

  1. Using different names, or at least "categorize" them, here it could be "container-contract: improve …"
  2. Following the PR template would be super cool 🙃

Sorry, thought these were quick fixes. Will do!

@afrittoli afrittoli added kind/documentation Categorizes issue or PR as related to documentation. and removed kind/documentation Categorizes issue or PR as related to documentation. labels Jul 13, 2020
afrittoli
afrittoli reviewed Jul 13, 2020
View reviewed changes
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks! A couple of comments

@tualeron tualeron changed the title Improve grammar and formatting. Rewrite the Container Contract doc to improve grammar and formatting. Jul 13, 2020
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 13, 2020
@tualeron
Improve grammar and formatting.
e50a630 
Improves grammar and formatting.
@tualeron tualeron changed the title Rewrite the Container Contract doc to improve grammar and formatting. Rewrite the "Container Contract" documentation for clarity and flow. Jul 14, 2020
vdemeester
vdemeester reviewed Jul 15, 2020
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2020
afrittoli
afrittoli reviewed Jul 15, 2020
View reviewed changes
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks!
/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 15, 2020
@tekton-robot tekton-robot merged commit 1b28720 into tektoncd:master Jul 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester left review comments

@afrittoli afrittoli afrittoli left review comments

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@vdemeester vdemeester

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tualeron @tekton-robot @pritidesai @vdemeester @afrittoli