We welcome and encourage community contributions to go-tuf.
Please familiarize yourself with these Contribution Guidelines before contributing.
There are many ways to help go-tuf besides contributing code:
Please follow the code of conduct when contributing to this project.
Unless you are fixing a known bug, we strongly recommend discussing it with the community via a GitHub issue or Slack (see Communication below for details) before getting started to ensure that your work is consistent with TUF's specification.
All contributions are made via pull request. All patches from all contributors get reviewed. See the Pull Request procedure.
To make a pull request, you will need a GitHub account. See GitHub's documentation on forking and pull requests.
Pull requests should be targeted at the master
branch. Before creating a pull request, go through this checklist:
master
so that changes do not get mixed up.master
branch.go test ./...
command and confirm that it passes (see TESTING.md for details).go fmt ./...
.git commit -s
(detailed information here).When creating a PR:
fix:
, feat:
, or similar).When all of the tests are passing, maintainer(s) will be assigned to review and merge the PR. If you're having trouble getting tests to pass, feel free to tag in MAINTAINERS for help, or ask in Slack (see Communication below).
We use the #tuf and #go-tuf channel on CNCF Slack. You are welcome to drop in and ask questions, discuss bugs, etc.
You might also be interested in the TUF community beyond go-tuf; good places to start include:
Maintainers should look in MAINTAINERS.md for detailed quidelines.