Skip to content

Improve development-related documentation #3677

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.

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

Merged
merged 2 commits into from
Jun 3, 2025
Merged

Improve development-related documentation #3677

merged 2 commits into from
Jun 3, 2025

Conversation

vy
Copy link
Member

@vy vy commented May 20, 2025

No description provided.

@vy vy self-assigned this May 20, 2025
@vy vy added the documentation Pull requests or issues that affect documentation label May 20, 2025
Copy link
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

This is a long overdue change, thanks!

I believe we've only just started drafting our Contributing Guide. While we do have a Development section that explains how to set up a local development environment, we should also create a separate guide focused specifically on contributing. This new guide should outline the requirements for submitting a pull request or making other types of contributions. It would help experienced Java developers quickly understand the (often arbitrary) project-specific contribution rules without needing to wade through setup instructions.

We can include a shortened version of our Contributing Guide as the checklist in our pull request template—for example, we could use something like this:

Checklist

Before we can review and merge your changes, please go through the checklist below. If you're still working on some items, feel free to submit your pull request as a draft—our CI will help guide you through the remaining steps.

✅ Required checks

  • License: I confirm that my changes are submitted under the Apache License, Version 2.0.

  • Commit Signatures: All commits are signed and verifiable (see GitHub Docs on Commit Signature Verification).

  • Code Formatting: The code is formatted according to the project’s style guide.

    How to check and fix formatting
    • To check formatting: ./mvnw spotless:check
    • To fix formatting: ./mvnw spotless:apply
  • Build & Tests: I verified that the project builds and all unit tests pass.

    How to build the project

    Run: ./mvnw verify

🧪 Tests (select one)

  • I have added or updated tests to cover my changes.
  • No additional tests are needed for this change.

📝 Changelog (select one)

  • I added a changelog entry in src/changelog/.2.x.x (see Changelog Entry File Guide).
  • This is a trivial change and does not require a changelog entry.

@vy
Copy link
Member Author

vy commented Jun 3, 2025

@ppkarwasz, applied your suggestions in 0ee4732.

@vy vy enabled auto-merge (squash) June 3, 2025 08:02
@vy vy merged commit 6fd9c62 into 2.x Jun 3, 2025
5 checks passed
@vy vy deleted the dev-doc branch June 3, 2025 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests or issues that affect documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants