From ae5a519d2a61c073069ae3993b0db1f57f650b4e Mon Sep 17 00:00:00 2001 From: Sergey Beryozkin Date: Thu, 31 Oct 2024 13:50:18 +0000 Subject: [PATCH 1/2] Explain how to rebase in the Contributing guide --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2dbff3a342ab0..9e728ccebf4bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,6 +177,15 @@ If you use different computers to contribute, please make sure the name is the s We use this information to acknowledge your contributions in release announcements. +We also recommend enabling a Pull rebase option: + +```sh +git config --global pull.rebase true +``` + +It will make it easier to rebase your PR branch against the latest `main` branch content with a `git rebase upstream main` command. +Make sure to register the remote `upstream` Quarkus repository with a `git remote add upstream https://github.com/quarkusio/quarkus` command. + ### Code reviews All submissions, including submissions by project members, need to be reviewed by at least one Quarkus committer before From 08da5fb52602858d7b5c2710bc7d65eaaed735e0 Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Thu, 31 Oct 2024 15:43:02 +0100 Subject: [PATCH 2/2] Some minor tweaking to rebase hint --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e728ccebf4bd..7a3c31e0d6ad9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,14 +177,14 @@ If you use different computers to contribute, please make sure the name is the s We use this information to acknowledge your contributions in release announcements. -We also recommend enabling a Pull rebase option: +We also recommend enabling the `pull.rebase` Git option (either globally or specifically for your Quarkus local clone): ```sh git config --global pull.rebase true ``` -It will make it easier to rebase your PR branch against the latest `main` branch content with a `git rebase upstream main` command. -Make sure to register the remote `upstream` Quarkus repository with a `git remote add upstream https://github.com/quarkusio/quarkus` command. +It will make it easier for you to rebase your pull request against the latest `main` branch using the `git pull upstream main` command. +Make sure to register the remote `upstream` Quarkus repository beforehand with `git remote add upstream https://github.com/quarkusio/quarkus`. ### Code reviews @@ -243,9 +243,9 @@ If you have not done so on this machine, you need to: * macOS: Use the `Disk Utility.app` to check. It also allows you to create a case-sensitive volume to store your code projects. See this [blog entry](https://karnsonline.com/case-sensitive-apfs/) for more. * Windows: [Enable case sensitive file names per directory](https://learn.microsoft.com/en-us/windows/wsl/case-sensitivity) * Install Git and configure your GitHub access - * Windows: + * Windows: * enable longpaths: `git config --global core.longpaths true` - * avoid CRLF breaks: `git config --global core.autocrlf false` + * avoid CRLF breaks: `git config --global core.autocrlf false` * Install Java SDK 17+ (OpenJDK recommended) * Install [GraalVM](https://quarkus.io/guides/building-native-image) * Install platform C developer tools: