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

Apply minor improvements to CONTRIBUTING.md #29347

Merged
merged 1 commit into from
Nov 18, 2022
+7 −8
Merged

Apply minor improvements to CONTRIBUTING.md #29347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ what you would expect to see. Don't forget to indicate your Quarkus, Java, Maven
## Checking an issue is fixed in main

Sometimes a bug has been fixed in the `main` branch of Quarkus and you want to confirm it is fixed for your own
application. Testing the `main` branch is easy and you have two options:
application. There are two simple options for testing the `main` branch:

* either use the snapshots we publish daily on https://s01.oss.sonatype.org/content/repositories/snapshots
* or build Quarkus all by yourself
* or build Quarkus locally

This is a quick summary to get you to quickly test main. If you are interested in having more details, refer to
The following is a quick summary aimed at allowing you to quickly test `main`. If you are interested in learning more details, refer to
the [Build section](#build) and the [Usage section](#usage).

### Using snapshots
Expand Down Expand Up @@ -134,14 +134,13 @@ You can check the last publication date here: https://s01.oss.sonatype.org/conte

Just do the following:

```
```sh
git clone [email protected]:quarkusio/quarkus.git
cd quarkus
export MAVEN_OPTS="-Xmx4g"
./mvnw -Dquickly
MAVEN_OPTS="-Xmx4g" ./mvnw -Dquickly
Copy link
Member

Choose a reason for hiding this comment

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

We did use an export on purpose. This way you don't have to do it every time you build the tree.

But I won't fight for it if you think this is better in this context.

Copy link
Contributor Author

@geoand geoand Nov 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

But the export only survives the current terminal session, no?
I usually find that when that is done, the next time someone tries to execute the command that follows the export, it will fail and people don't know why.

On the other hand, when using the syntax I propose, you get the entire command in the shell history

```

Wait for a bit and you're done.
Building can take a few minutes depending on the hardware being used.

**Note** For Apple Silicon computer, Rosetta must be installed. It can be done using `softwareupdate --install-rosetta`

Expand All @@ -162,7 +161,7 @@ To contribute, use GitHub Pull Requests, from your **own** fork.

Also, make sure you have set up your Git authorship correctly:

```
```sh
git config --global user.name "Your Full Name"
git config --global user.email [email protected]
```
Expand Down