From bf8301a05264a6fde80317872413027eb2c3315e Mon Sep 17 00:00:00 2001 From: keroro Date: Thu, 2 Jun 2022 16:13:40 +0800 Subject: [PATCH] docs: add CONTRIBUTING.md --- README.md | 4 ++++ docs/CONTRIBUTING.md | 16 ++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index 4a02e9fc..7354930f 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,10 @@ Whenever you encounter a problem with Kicker, please let us know by providing th - Service running status: `./kicker ps` - Service logs: `./kicker logs` +## Contributing to Godwoken-Kicker + +[CONTRIBUTING.md](docs/CONTRIBUTING.md) + ## More * [Manual build mode](docs/manual-build.md) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..5e7bd5dc --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing to Godwoken-Kicker + +We use the [Trunk-Based Development Flow](https://trunkbaseddevelopment.com/branch-for-release/). We maintain only one long-lived branch, the "main" branch. + +## Pull Request + +- Most of the time, you should submit PRs to the "main" branch. +- When submitting PR and it should be noted in the release note, please write down the release note in the PR description and mark the PR with "release-note" label +- When submiting PR and it brings breaking-changs, please please write down the release note in the PR description and mark the PR with "release-note" and "breaking-change" label + +## Release Process + +- At the scheduled time, checkouts a "rc-" branch from the current "main" branch +- As for non-emergence commits and patches, submit PRs to the "main" branch, then cherry-pick commits from "main" to "rc-" +- As for emergence hotfix, although Godwoken-Kicker should have no emergence hotfixes, make PRs to "rc-hotfix" branch, then cherry-pick to "main" branch. +- Since Godwoken-Kicker is not a production project, we don't have to maintain a CHANGELOG.md.