summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorYarden Shoham <hrsi88@gmail.com>2022-10-15 19:41:24 +0300
committerGitHub <noreply@github.com>2022-10-15 12:41:24 -0400
commit671c609c465f02d7ac5023bb8491694a9f4768f5 (patch)
tree215f78013a7e02fe1e373a6b320e71f411e7ece4 /CONTRIBUTING.md
parenta33ff822ffc84b0d99d122ca9dabfedc583e9f8c (diff)
downloadgitea-671c609c465f02d7ac5023bb8491694a9f4768f5.tar.gz
gitea-671c609c465f02d7ac5023bb8491694a9f4768f5.zip
Add wording about keeping PRs up-to-date in CONTRIBUTING.md (#21468)
Following a discord discussion from today I've written the policy explained to me about keeping PRs up-to-date. Signed-off-by: Yarden Shoham <hrsi88@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4aff27fc65..dbe418c356 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -146,6 +146,16 @@ If your PR could cause a breaking change you must add a BREAKING section to this
To explain how this could affect users and how to mitigate these changes.
+Once code review starts on your PR, do not rebase nor squash your branch as it makes it
+difficult to review the new changes. Only if there is a need, sync your branch by merging
+the base branch into yours. Don't worry about merge commits messing up your tree as
+the final merge process squashes all commits into one, with the visible commit message (first
+line) being the PR title + PR index and description being the PR's first comment.
+
+Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking
+builds (unless there's a merge conflict or a request is made by a maintainer to make
+modifications). It is the maintainer team's responsibility from this point to get it merged.
+
## Styleguide
For imports you should use the following format (*without* the comments)