Skip to content
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

docs: Add release process info for maintainers #336

Merged
merged 1 commit into from
Jul 8, 2022
Merged

docs: Add release process info for maintainers #336

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
10 changes: 7 additions & 3 deletions docs/MAINTAINERS.md
View file
Open in desktop
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.
znewman01 marked this conversation as resolved.
Show resolved Hide resolved
- We will develop more process around project management after we get through the v0.4.0 release.

## Review checklist
Expand Down