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

Use markdown headers instead of bold text for PR template #96884

Merged
merged 1 commit into from Feb 10, 2021
Merged

Use markdown headers instead of bold text for PR template #96884

merged 1 commit into from Feb 10, 2021

Conversation

saschagrunert
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The usage of markdown headers will provide a more eye-friendly
formatting without having a need to add additional newlines to the PR.
This is reasoned by the GitHub markdown parser which adds additional
space before and after the header.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

None

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

None

Example

Before

The markdown:

**What type of PR is this?**
/kind documentation
**What this PR does / why we need it**:
Lorem ipsum

Renders:

What type of PR is this?
/kind documentation
What this PR does / why we need it:
Lorem ipsum

After

The markdown:

#### What type of PR is this?
/kind documentation
#### What this PR does / why we need it:
Lorem ipsum

Renders:

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Lorem ipsum

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Nov 26, 2020
@saschagrunert
Copy link
Member Author

/sig contibutor-experience

@k8s-ci-robot
Copy link
Contributor

@saschagrunert: The label(s) sig/contibutor-experience cannot be applied, because the repository doesn't have them

In response to this:

/sig contibutor-experience

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. label Nov 26, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Nov 26, 2020
justaugustus
justaugustus requested changes Nov 28, 2020
View reviewed changes
Copy link
Member

@justaugustus justaugustus left a comment

Choose a reason for hiding this comment

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

@saschagrunert -- Could you do the same for all of the templates in https://github.com/kubernetes/kubernetes/tree/master/.github/ISSUE_TEMPLATE?

@saschagrunert
Use markdown headers instead of bold text for PR template
d0a3ecf 
The usage of markdown headers will provide a more eye-friendly
formatting without having a need to add additional newlines to the PR.
This is reasoned by the GitHub markdown parser which adds additional
space before and after the header.

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 30, 2020
@saschagrunert
Copy link
Member Author

@saschagrunert -- Could you do the same for all of the templates in https://github.com/kubernetes/kubernetes/tree/master/.github/ISSUE_TEMPLATE?

Yep sure, done 👍

@saschagrunert
Copy link
Member Author

saschagrunert commented Nov 30, 2020 •
edited

/test pull-kubernetes-e2e-kind

@saschagrunert
Copy link
Member Author

@justaugustus do you see anything which has to be done here?

@justaugustus
Copy link
Member

/lgtm
/assign @mrbobbytables

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 1, 2021
@mrbobbytables
Copy link
Member

/triage accepted
/approve
/hold
/assign @cblecker @nikhita @alisondy
For any additional comments

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 9, 2021
@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Feb 9, 2021
nikhita
nikhita approved these changes Feb 9, 2021
View reviewed changes
Copy link
Member

@nikhita nikhita left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

Please free to cancel the hold at your discretion :)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrbobbytables, nikhita, saschagrunert

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

@saschagrunert
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 10, 2021
@k8s-ci-robot k8s-ci-robot merged commit d08ac1d into kubernetes:master Feb 10, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Feb 10, 2021
@saschagrunert saschagrunert deleted the headers branch February 10, 2021 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justaugustus justaugustus justaugustus requested changes

@nikhita nikhita nikhita approved these changes

@castrojo castrojo Awaiting requested review from castrojo

Assignees

@justaugustus justaugustus

@cblecker cblecker

@mrbobbytables mrbobbytables

@nikhita nikhita

@alisondy alisondy

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.21
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@saschagrunert @k8s-ci-robot @justaugustus @mrbobbytables @nikhita @cblecker @alisondy