docs: minor updates to README
All checks were successful
Rust / build (push) Successful in 1m13s
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
ci/woodpecker/cron/cron-docker-builder Pipeline was successful
ci/woodpecker/cron/push-next Pipeline was successful
ci/woodpecker/cron/tag-created Pipeline was successful
All checks were successful
Rust / build (push) Successful in 1m13s
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
ci/woodpecker/cron/cron-docker-builder Pipeline was successful
ci/woodpecker/cron/push-next Pipeline was successful
ci/woodpecker/cron/tag-created Pipeline was successful
This commit is contained in:
parent
12849d5a69
commit
6c24a36476
1 changed files with 8 additions and 4 deletions
12
README.md
12
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.
|
||||
|
||||
|
|
Loading…
Reference in a new issue