Skip to content

Commit

Permalink
chore: add branch breakdown to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
okdv committed Apr 20, 2024
1 parent 4ac08d0 commit 4fc38c3
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Self-hosted, flexible maintenance tracker for your cars, bikes, and everything i

**WARNING**: This project is under active development in an alpha state, effectively an MVP. Would not recommend using yet unless you plan to contribute in some way, otherwise a beta release will be coming soon. This will be where everyday self hosters would likely benefit from the service.

## Branches
`develop`: The latest, unstable, branch. Where all commits are made to, and where all contributing branches are branched from. Though tested first, likelihood of broken things is fairly good.
`main`: stable channel/branch. should pretty much always match the latest release branch
`vX.X.X[-stage]`: particular version/release, e.g. v1.0.0-alpha, v.4.2.0

## Running (Production)

Clone repo, open in terminal
Expand Down Expand Up @@ -56,8 +61,8 @@ If you simply want to use Node to render the frontend for development, run
1) Fork repository
2) Clone your fork
- `git clone https://github.com/your-username/wrench-turn.git && cd wrench-turn`
3) Create a branch for what you're working on at that time
- `git checkout -b super-cool-feature`
3) Create a branch off of the develop branch for what you're working on at that time
- `git checkout -b super-cool-feature develop`
4) Commit and push
- `git add . && git commit -m "feat: super awesome feature #420" && git push origin super-cool-feature`
- **Note:** git pre-commit hook will attempt to run `go build`, `go test` successfully before committing
Expand Down

0 comments on commit 4fc38c3

Please sign in to comment.