Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (49 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

84 lines (49 loc) · 2.57 KB
Raw

Contributing guide

Want to contribute? Great! We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... But first, read this page.

Roq is part of the Quarkus ecosystem, contributions should follow the same principles when applicable (https://github.com/quarkusio/quarkus/blob/main/CONTRIBUTING.md).

Reporting an issue

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

If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing, and what you would expect to see. Don't forget to indicate your Quarkus, Java, Maven/Gradle, and GraalVM versions.

Tests and documentation are not optional

Don't forget to include tests in your pull requests. Also don't forget the documentation (reference documentation, javadoc, etc.).

LLM Usage Policy

See https://github.com/quarkusio/quarkus/blob/main/CONTRIBUTING.md#llm-usage-policy

Moreover, once the commit is shared, it belongs to you, there should not be any co-authored by usage. You are fully accountable for your commits.

Running

This project uses Java 21 and Maven as build tooling.

To run the tests, use the following:

mvn verify

Code Style

Maven automatically formats code and organizes imports when you run mvn verify. So, we recommend you do that before sending your PR. Otherwise, PR checks will fail.

Installing Roq extensions

To install all Roq extensions, we need to run:

mvn clean install

Running Blog

There are two ways for running the blog locally:

  • With live reload: Great when you are writing your blog.
  • Serving your static site: When you want to see how your blog looks before deployment.

Running with live reload

Using the Roq CLI:

cd blog && roq start

Or using Maven directly:

cd blog && mvn quarkus:dev

Now, you can access: http://localhost:8080 and be happy!

Press s in the dev terminal to force a soft restart (useful after rebuilding a module). If changes are still not picked up, kill the server and restart it.

Serving your static site

cd blog && roq generate
roq serve

See the Roq documentation for more details.

For the maintainers

Backlog

We have a Kanban board, which is currently visible only by members of the Quarkiverse organization.