Added contrib guide

dev
Mark 2023-09-29 10:18:10 -07:00
parent 5788ffa085
commit d9730fd699
Signed by: Mark
GPG Key ID: AD62BB059C2AAEE4
1 changed files with 31 additions and 0 deletions

31
CONTRIBUTING.MD Normal file
View File

@ -0,0 +1,31 @@
# Contribution guidelines for Daisy
## Pull requests
All PRs should merge to `dev`. See "branching" below.
## Versioning
Daisy uses [semantic versioning](https://semver.org/), which looks like `maj.min.patch`. In short:
- `maj`: Incremented on large, incompatible changes
- `min`: Incremented on new features
- `patch`: Incremented on bugfixes
Whenever one of the above fields is incremented, all sub-fields are reset to zero. When `min` is incremented, `patch` is set to zero.
## Branching
Daisy uses a branch model much like the one described [here](https://nvie.com/posts/a-successful-git-branching-model).
- `master`: 1 commit = 1 release. This is always a merge comit from `dev`, and is always tagged with a version.
- `dev`: main development branch. Never deleted. Most work happens here.
- `features`: temporary branches pulled from `dev` and merged to `dev` for larger features.
- Always merge with git's `--no-ff` option for a more detailed history.
## Releases
What to do
- Merge into `master` (`git merge --no-ff dev`)
- Tag merge commit on `master` (`git tag -a v1.0.0 -m "Version 1.0.0"`)
- `cargo publish`
- Update web demo & pull server (`make docker`)
- Update aur package