Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 2.18 KB
Raw

Contributing guide

Want to contribute to quickstarts? That's awesome!

We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, new quickstarts...

But first, please read this page.

Reporting an issue

This project uses GitHub issues to manage the issues. Open an issue directly in GitHub.

Before you contribute and structure of the repository

To contribute, use GitHub Pull Requests, from your own fork.

  • The main branch uses the latest release of Quarkus.
  • The development branch uses a snapshot version of Quarkus.

All contributions must target the development branch. The main branch is reset for each release.

All changes made only to the main branch will be definitely lost.

For pull requests depending on features not yet merged in Quarkus, prepend the title with "[DO NOT MERGE]".

Code reviews

All submissions, including submissions by project members, need to be reviewed before being merged.

Continuous Integration

Because we are all humans, the project use a continuous integration approach and each pull request triggers a full build. Please make sure to monitor the output of the build and act accordingly.

Tests and documentation are not optional

  • All quickstarts must contain unit tests,
  • All quickstarts supporting the native mode must contain native tests,
  • If your quickstart does not work in native mode, point it out in the pull request,
  • New quickstarts must be listed in the README.md page

Build with Maven

  • Clone the repository: git clone https://github.com/quarkusio/quarkus-quickstarts.git
  • Navigate to the directory: cd quarkus-quickstarts
  • Invoke mvn clean verify -Pnative from the root directory
git clone https://github.com/quarkusio/quarkus-quickstarts.git
cd quarkus-quickstarts
mvn clean verify -Pnative
# Wait... success!

Build with Gradle

Clone like above, and build e.g. getting-started using:

../gradlew build

You'll find the quarkus-app/quarkus-run.jar in build (not build/libs).

The small print

This project is an open source project, please act responsibly, be nice, polite and enjoy!