| title |
|---|
Contributing to TUF |
We welcome community contributions to TUF, whether they be documentation, a bug fix or a new feature. If you are planning on making more elaborate or potentially controversial changes, please discuss them in the TUF slack channel or on the mailing list before sending a pull request. We host public community meetings focused on TUF development and contributions. These meetings are meant for developers and maintainers to meet, get unblocked, pair review, and discuss development aspects of the TUF.
First, you should join our communication forums:
- Join us on the TUF slack channel.
- Join us via the mailing list.
- Join monthly community meetings.
Next, get set up with the basics:
- Take an overview
- Getting started guide
- Set up using Implementations
- Uses of TUF by videos or blogs
Check out TUF repositories for existing issues or to add one. A contributor can submit GitHub pull request to the project's repositories by following:
- the CNCF code of conduct.
- the Developer Certificate of Origin (DCO).
- test locally any new feature or change.
Maintainers will review and give feedback on pull requests.
We recommend that you work on existing issues before attempting to develop a new feature.
Find an existing issue (e.g. one marked good first issue, or simply ask an owner for suggestions on channel), and respond on the issue thread expressing interest in working on it.
This helps other people know that the issue is active, and hopefully prevents duplicated efforts.
Each commit must be signed off in git.
- Documentation can always use improvement.
- Review open PRs. Add comments, feedback, or give an LGTM!
- Try out some easy-to-fix bugs which may be marked with the good first issue tag.
- Just ask on the channel for suggestions.
- Submit an issue describing your proposed change to the repo in question.
- For security issues follow this.
- The repo owners will respond to your issue promptly.
- If your proposed change is accepted, follow Development guideline.
- Submit a pull request containing a tested change.
Contributors must indicate acceptance of the Developer Certificate of Origin by appending a Signed-off-by: Your Name [email protected] to each git commit message or use -s tag with git commit.
- python-tuf (this repository is a reference implementation written in Python)
- specification (The Update Framework specification)
- theupdateframework.io (Website assets for TUF)
- community (Community Repository of TUF)
- taps (TUF Augmentation Proposals (TAPs))
- tuf-on-ci (A TUF repository and signing tool)
- rust-tuf (Rust implementation of The Update Framework (TUF))
- go-tuf (Go implementation of The Update Framework (TUF))
- tuf-js (JavaScript implementation of The Update Framework (TUF))
Join us on the #TUF channel on CNCF Slack.
Join us via the mailing list.
- Time: every fourth Wednesday of the month, at 11am (Eastern Time)
- Location: meet.google.com/jhk-cvuf-icd
- Agenda: hackmd.io/jdAk9rmPSpOYUdstbIvbjw
- Calendar: www.cncf.io/calendar
Understand our governance.