c738487ef5
pull-requests.md: add guidance for large and/or automatic edits
...
This primarily came out of the discussion around allowing the use of
LLMs (https://github.com/kubernetes/steering/issues/291 ), but isn't limited to
it because other tools (search/replace, linters) can have the same effect.
The goal is to clarify expected behavior and to give reviewers something that
they can link to when they decide that a PR shouldn't get merged.
2025-05-15 13:36:09 +02:00
e337d98fcd
PRs: document policy around linter checks
...
Occasionally contributors run linters, fix issues found by them (sometimes
automatically!) and then create PRs. This creates work for maintainers and is
often not useful, so let's write this down. Perhaps future contributors will
find it, if not, we can point to it in PRs when closing them.
2024-11-05 09:21:24 +01:00
a2bf3347cb
Merge pull request #7884 from Okabe-Junya/fix-7883
...
docs: fix broken links related to k/test-infra/prow
2024-06-08 12:29:28 -07:00
0adfecd04d
fix: use https:// instead of http://
2024-06-09 02:22:43 +09:00
0991742988
Merge pull request #6530 from MadhavJivrajani/merge-method-squash-docs
...
guide: Add more docs around tide/merge-method-squash
2024-05-21 01:21:15 -07:00
c0e379d50f
update: links
2024-05-08 15:19:02 +09:00
0005b427da
Link to documentation site and clarify PR/CLA order
2023-09-29 10:04:26 -06:00
c85d66e000
Add a section to the pull-request docs about giant multi-SIG PRs
2023-05-02 08:15:42 -04:00
4feca6b6e7
updated contributors/guide/pull-requests.md
...
Signed-off-by: amolmote <amolmote201@gmail.com>
2022-09-11 08:59:36 +05:30
d429aeb0a2
guide: Add more docs around tide/merge-method-squash
...
This commit adds more information about the label
`tide/merge-method-squash` and shows what the commit
message ends up looking like if the label is used on
multiple commits, especially if the PR contains fixup
commits like "address reviews".
Adding this documentation to better illustrate the
effects of using this label as opposed to squashing
by hand and preserve good commit message practices.
Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
2022-03-09 16:54:37 +05:30
a4873c6e8c
Remove bold formatting
2021-10-27 13:39:08 +05:30
f1279464b0
Reword github keywords usage in PR and commit messages
2021-10-26 14:33:46 +05:30
99da412655
Typos and other punctuation fixes
2021-06-22 12:25:57 -07:00
c4906d2ad9
Add documentaion for tide/squash-on-merge to pull-request.md and contributor-cheatsheet
...
- adding documentation increases awareness that this label exists and can help PRs get merged quicker
- Manual squash causes removal of lgtm label and re-run of CI tests.
Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
2021-05-13 21:51:57 +05:30
7535165e34
tiny whitespace fix
...
For the more compulsive among us, let's have a space just before a sentence begins.
2020-11-19 00:27:16 +02:00
d27cb26831
Deduplify content: Remove reviewee content from the review-guidelines ( #5031 )
...
* Deduplify content: Remove reviewee content from the review-guidelines,
reorganize pull request page.
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
* Reformat ToC headers, move KISS section higher
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
2020-08-17 17:09:30 -07:00
427ccfbc7d
Add frontmatter descriptions to the contributor guide docs
2020-06-19 07:44:44 -04:00
e3db935944
feat: Adding guidance on commit message style ( #4343 )
...
* feat: Adding guidance on commit message style
* Update commit message guidelines
* Add notes on kind/area
Co-authored-by: Bob Killen <bob.killen@linux.com>
2020-06-04 12:18:38 -07:00
7b7ba09a57
Improve squashing documentation ( #4668 )
...
* Improve squashing documentation
Signed-off-by: Celeste Horgan <celeste@cncf.io>
* Apply suggestions from code review
Co-Authored-By: Bob Killen <killen.bob@gmail.com>
* Update contributors/guide/github-workflow.md
Co-Authored-By: Bob Killen <killen.bob@gmail.com>
Co-authored-by: Bob Killen <killen.bob@gmail.com>
2020-04-06 05:11:46 -07:00
16c3c0a861
Assigning weights to contributor documents for proper surfacing
2020-02-10 19:03:37 +05:30
a886fa31e9
feat: Documentation about ok-to-test label
2019-12-24 00:26:12 +05:30
de5ad57f8c
contributor-guide: add note about #pr-reviews channel
2019-10-16 11:44:13 +05:30
463f51476f
Update contributor guide formatting to be Hugo compatible.
2019-10-08 19:55:55 -04:00
8cbd38c424
Fix broken link from PR guide to KEP process guide
...
Signed-Off-By: Daniel Lipovestky <daniel@platform9.com>
Co-Authored-By: Christoph Blecker <admin@toph.ca>
2019-08-05 10:41:02 -07:00
3386f743e2
Reviewd and updated spelling, grammar and punctuation. ( #3826 )
...
* Reviewd and updated spelling, grammar and punctuation.
* Update contributors/guide/pull-requests.md
Co-Authored-By: Christoph Blecker <admin@toph.ca>
* Update contributors/guide/pull-requests.md
Co-Authored-By: Christoph Blecker <admin@toph.ca>
2019-06-21 14:32:13 -07:00
b5f3b03205
Add hugo metadata to the contributor guides
...
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
2019-06-04 15:24:44 -04:00
cabb6548fe
change old link to new link
2019-05-07 17:25:02 +09:00
4644fb47e7
all URL pointing to kubectl-conventions.md have been fixed
2019-02-06 16:22:26 -06:00
f684fcb8df
file release.md has been moved to /devel/sig-release - URLs in k/community updated
2019-01-29 11:23:48 -06:00
e4640f049e
Clarify the use of lgtm and approve labels
...
Clarify the use of lgtm and approve labels, and call out special
cases which may result in surprising behavior by the code review
system.
2018-10-24 17:31:23 -07:00
c2bd5cb839
Replace submit queue with Tide in docs
2018-10-06 23:08:24 +05:30
0ebcc778e3
contrib guide: update link
...
The SIG-Release ephemera on issue workflow is moved to the devel guide.
Updating reference to it.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-08-30 17:28:32 -07:00
15c88b5b96
Adds the 'trivial edit contribution policy'
...
Added the text from #1628 under 'Best Practices for Faster Reviews' and linked it at the top of the document.
Issue: #1628
2018-08-26 23:02:12 +02:00
bb220cc04a
add section on prs being held up by release cycle
2018-07-30 17:19:31 -04:00
261cb0fd08
Change k8s-merge-robot to k8s-ci-robot
2018-03-15 06:48:54 +08:00
405849f487
Release Notes: Title added; minor cleanup. Faster reviews tombstone added. Minor cleanup in pull-requests.md
2018-02-22 14:42:13 -08:00
66eb35601d
Explains how to assign a reviewer using a bot command
...
Pinging someone with a github mention is different from using a bot command to assign them as a reviewer. This commit includes a specific explanation.
2018-02-22 14:42:13 -08:00
313ded24d3
Fixes table, capitalization, and in-doc links
...
This addresses a few broken links that resulted from style changes.
2018-02-22 14:41:57 -08:00
f71f80ce56
Major rewrite of pull request process
...
The pull-requests.md document has gotten quite out of date. This commit
does a massive scrub of its content for completeness, accuracy and
readability. A number of links are fixed, updated information on labels
and bot commands is added, workflow descriptions for test and merge are
updated, and a description of the KEP process is added.
2018-02-19 21:20:17 -08:00
98bea78a76
contrib guide: move pull-requests.md from devel/ to guide/
...
Understanding the pull request process is central to being a successful
contributor. This commit moves it from the more technical k8s internals
detailed devel/ area over to the guide/ where it will get more
visibility.
This patch just moves the file and leaves a tombstone reminder
behind.
2018-02-19 21:20:17 -08:00
Patrick Ohly
Kubernetes Prow Robot
Junya Okabe
Tim Schaub
Dan Winship
amolmote
Madhav Jivrajani
Avinash Upadhyaya K R
Pushkar Joglekar
Dan Kenigsberg
Jorge O. Castro
Bob Killen
vishakha
Celeste Horgan
vishakha
Nikhita Raghunath
Bob Killen
Daniel Lipovetsky
cryptographicfool
toyoda
eduartua
Chris Hoge
Tim Pepper
Tobias Nehrlich
Jeffrey Sica
bin liu
guineveresaenger