kemitix/git-next
1
1
Fork 1
Code Issues 14 Pull requests 1 Projects 1 Releases 41 Packages Wiki Activity Actions

docs: minor updates to README
All checks were successful
Rust / build (push) Successful in 1m13s
Details
ci/woodpecker/push/cron-docker-builder Pipeline was successful
Details
ci/woodpecker/push/push-next Pipeline was successful
Details
ci/woodpecker/push/tag-created Pipeline was successful
Details
ci/woodpecker/cron/cron-docker-builder Pipeline was successful
Details
ci/woodpecker/cron/push-next Pipeline was successful
Details
ci/woodpecker/cron/tag-created Pipeline was successful
Details

Browse source
This commit is contained in:
Paul Campbell 2024-07-04 19:04:02 +01:00
parent 12849d5a69
commit 6c24a36476
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,6 +1,6 @@
# git-next # git-next
- Status: Alpha - dog-fooding - Status: **BETA** - dog-fooding
`git-next` is a combined server and command-line tool that enables trunk-based `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 development workflows where each commit must pass CI before being included in
@ -8,11 +8,13 @@ the main branch.
## Features ## 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 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 - 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 ## Prerequisits
@ -178,6 +180,8 @@ untested and undefined.
## Behaviour ## 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 Development happens on the `dev` branch, where each commit is expected to
be able to pass the CI checks. be able to pass the CI checks.