Skip to content

T0T: README branch-model note #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mwlang wants to merge 1 commit into from
Closed

T0T: README branch-model note #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

### Branch model (prodigy-workspace development)

When developed as part of the parent prodigy workspace, this sub-repo maintains
two long-lived branches: **`main`** (production-deployable; only authorized
closes land here via cherry-pick) and **`staging`** (integration view; every
in-flight feature merges here on the in-progress → implemented transition).
Feature branches start from `main`, integrate to `staging`, and land on `main`
via `git cherry-pick -m 1 {staging-merge-SHA}` at close. Gem releases continue
to flow from `main` per the standard release procedure above. Full procedure +
rebuild recipe in the parent workspace's [`doc/runbooks/branch-model.md`](../../../doc/runbooks/branch-model.md)
(only resolvable when this repo is cloned as part of the prodigy workspace).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mwlang/quantitative. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mwlang/quantitative/blob/main/CODE_OF_CONDUCT.md).
Expand Down
Loading