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.
Where to go
Pick the right place
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:
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.
Fork, then branch from develop
Work on a
fix/…orfeature/…branch cut fromdevelop, the integration branch.bashgit clone https://github.com/<you>/ReleaseFlow.gitcd ReleaseFlowgit switch -c fix/short-description origin/developBuild and test locally
You need JDK 21 and Docker, which runs PostgreSQL for the tests. Run
./mvnw verify,npm run e2ewhen a page changed, andnpm --prefix website run buildwhen a guide changed.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.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.
How the project runs
Everything happens where you can see it.
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.