Skip to main content

Community

Build ReleaseFlow in the open.

Questions, bug reports, docs fixes and code all move the project forward. Here is where each one goes, and what happens after you send it.

Contributing

Your first pull request​

ReleaseFlow grows in small, reviewable slices, so small and focused changes are the easiest to land. Browse the issues by label:

  1. Agree on the change first

    Pick or open an issue. For anything bigger than a fix, talk the approach through in Discussions before you write it.

  2. Fork, then branch from develop

    Work on a fix/… or feature/… branch cut from develop, the integration branch.

    bash
    git clone https://github.com/<you>/ReleaseFlow.git
    cd ReleaseFlow
    git switch -c fix/short-description origin/develop
  3. Build and test locally

    You need JDK 21 and Docker, which runs PostgreSQL for the tests. Run ./mvnw verify, npm run e2e when a page changed, and npm --prefix website run build when a guide changed.

  4. Open a pull request to develop

    Title it as a Conventional Commit, such as fix(webhook): reject repository identity mismatch. CI, CodeQL, Dependency Review and Secret Scan run on it, and a behaviour change adds its line to the changelog under Unreleased.

  5. Review and merge

    The maintainer reviews it and squashes it into develop as one commit. Your contribution is licensed under Apache 2.0, with no separate agreement to sign.

Maintainer​

Luong Tran Chu Hoang

Creator and maintainer of this personal project

@hoangluongtran0309(opens in new tab)

Code of Conduct​

ReleaseFlow follows the Contributor Covenant 2.1 in issues, pull requests, discussions and every other project space. Report unacceptable behaviour privately to hoangluongtran0309@gmail.com; the reporter’s identity is kept private.

Read the Code of Conduct(opens in new tab)