From 6c24a364764c7cccc87dd5cc41b4671fb8afad47 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 4 Jul 2024 19:04:02 +0100 Subject: [PATCH] docs: minor updates to README --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6424329..b2fd6f7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # git-next -- Status: Alpha - dog-fooding +- Status: **BETA** - dog-fooding `git-next` is a combined server and command-line tool that enables trunk-based development workflows where each commit must pass CI before being included in @@ -8,11 +8,13 @@ the main branch. ## Features -- Enforce the requirement for each commit to pass the CI pipeline before being +- Allows enforce the requirement for each commit to pass the CI pipeline before being included in the main branch -- Provide a server component that manages the trunk-based development process +- Provides a server component that manages the trunk-based development process - Ensure a consistent, high-quality codebase by preventing untested changes - from being merged + from being added to main + +See [Behaviour](#behaviour) to learn how we do this. ## Prerequisits @@ -178,6 +180,8 @@ untested and undefined. ## Behaviour +The branch names are configurable, but we will talk about `main`, `next` and `dev`. + Development happens on the `dev` branch, where each commit is expected to be able to pass the CI checks.