Skip to content

Commit

Permalink
docs: Add release process info for maintainers (#336)
Browse files Browse the repository at this point in the history
Signed-off-by: Zachary Newman <[email protected]>
  • Loading branch information
znewman01 authored Jul 8, 2022
1 parent f5f12b1 commit 0f17236
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,20 @@ Speedy communication makes contributors happy!
Versioning:

- go-tuf releases follow [SemVer](https://semver.org/) with the following modification:
- While go-tuf is pre-1.0, increment the minor version for any breaking changes (in SemVer, there are no guarantees about API stability).
- Releases should be tagged in this repository as usual in Go ([Publishing a module](https://go.dev/doc/modules/publishing)).
- While go-tuf is pre-1.0, increment the minor version for any breaking changes (in SemVer, there are no guarantees about API stability before 1.0).
- Releases should be tagged in this repository as usual in Go (e.g. `v0.3.1`; see [Publishing a module](https://go.dev/doc/modules/publishing)).
- All maintainers should have permissions to push an appropriately-named `tag`, which will trigger the full release process.
- A patch release can happen at any point, but give the other maintainers 1 day's notice via Slack or GitHub first.
- For a minor release, see the "Project management" tag below.
- We may revisit this policy post-1.0.

Project management:

- Try to keep issues up-to-date with status updates!
- Feel free to ping open issues to check on them.
- Use the "assignee" field to indicate when you are working on an issue.
- Use GitHub issue labels to describe the issue (exact labels are still changing, so just look through and add those that seem like a good fit).
- Before publishing a new release, there should be an associated [GitHub project](https://github.com/theupdateframework/go-tuf/projects?type=beta) to track issues.
- Before publishing a new minor release, there should be an associated [GitHub project](https://github.com/theupdateframework/go-tuf/projects?type=beta) to track issues.
- We will develop more process around project management after we get through the v0.4.0 release.

## Review checklist
Expand Down

0 comments on commit 0f17236

Please sign in to comment.