diff --git a/.github/ISSUE_TEMPLATE/release_planning.md b/.github/ISSUE_TEMPLATE/release_planning.md new file mode 100644 index 000000000..e73af43cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_planning.md @@ -0,0 +1,57 @@ +# Release vX.Y.Z Planning + +> **Release Goal:** _One or two sentences describing what this release achieves and why it matters. Keep it scope-defining._ + +- **Target Date:** YYYY-MM-DD +- **Release Manager:** @username + +--- + +## Breaking Changes + +_List any changes that break backward compatibility. If none, write "None."_ + +- [ ] `[ChangeDescription]` — _What it breaks and what users should do instead._ + +--- + +## Issues and PRs + +_List issues and PRs along with their current status (example:_ `Planned`, `In progress`, `Awaiting review`, `Awaiting changes`, `Ready to merge`, `Merged`, `Postponed`, `Moved to vX.Y`_)_ + +### Features + +| Issue / PR | Feature | Description | Status | +| ---------- | ------------- | ------------------- | ----------------- | +| [#](#) | `FeatureName` | _Short description_ | `Planned` | +| [#](#) | `FeatureName` | _Short description_ | `Awaiting review` | + +--- + +### Improvements & Refactors + +_Performance/tooling improvements, refactors, dependency upgrades, etc._ + +| Issue / PR | Improvement | Description | Status | +| ---------- | ----------------- | --------------- | ------------------ | +| [#](#) | `ImprovementName` | _Short summary_ | `Awaiting changes` | + +--- + +### 🐛 Bug Fixes + +_Bugs confirmed for this release. Urgent bugs discovered mid-cycle can be added here as they come up._ + +| Issue / PR | Bug | Description | Status | +| ---------- | --------- | --------------- | ------------- | +| [#](#) | `BugName` | _Short summary_ | `Merged` | +| [#](#) | `BugName` | _Short summary_ | `In progress` | + +--- + +## Testing Checklist + +_Things to verify before cutting the release._ + +- [ ] CI tests pass (unit, e2e, integration) +- [ ] Manual smoke tests on critical flows diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 841aaaadd..07dffd394 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -401,6 +401,12 @@ The following checks must pass before a PR can be merged: All contributors must have a CLA on file with FINOS before PRs can be merged. Review the FINOS [contribution requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements) and submit the required CLA. +## Releases + +Our release process starts with making a [planning document](./.github/ISSUE_TEMPLATE/release_planning.md) for every minor/major release. Here, we plan the issues and PRs to include. We aim to release on a quarterly basis, but emergency patches/releases outside the usual schedule may also be done arbitrarily. + +If you'd like to include a certain feature, issue or PR in a given release, feel free to comment on the relevant planning issue. We also discuss PRs for the next release in our Community Meetings - that's another great place to make suggestions! + ## Community - **Slack**: [#git-proxy](https://finos-lf.slack.com/archives/C06LXNW0W76) on the FINOS Slack workspace