-
Notifications
You must be signed in to change notification settings - Fork 20
adding contribute page on website. #54
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.
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
Open
h4l0gen
wants to merge
2
commits into
theupdateframework:main
Choose a base branch
from
h4l0gen:add_contributing_page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
--- | ||
title: Contributing to TUF | ||
--- | ||
|
||
We welcome community contributions to [TUF](https://github.com/theupdateframework), 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](#slack-channel) or on the [mailing list](#mailing-list) before sending a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). We host public [community meetings](#community-meeting) focused on [TUF](https://github.com/theupdateframework) development and contributions. These meetings are meant for developers and maintainers to meet, get unblocked, pair review, and discuss development aspects of the [TUF](https://github.com/theupdateframework). | ||
___ | ||
|
||
### Contributor Workflow | ||
First, you should join our communication forums: | ||
- Join us on the [TUF slack channel](#slack-channel). | ||
- Join us via the [mailing list](#mailing-list). | ||
- Join monthly [community meetings](#community-meeting). | ||
|
||
Next, get set up with the basics: | ||
- Take an [overview](./overview.md) | ||
- [Getting started guide](./security.md) | ||
- Set up using [Implementations](./implementations.md) | ||
- Uses of TUF by [videos](./videos.md) or blogs | ||
|
||
Check out TUF [repositories](#tuf-repositories) for existing issues or to add one. A contributor can submit [GitHub pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the project's [repositories](#tuf-repositories) by following: | ||
|
||
- the [CNCF code of conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
- the Developer Certificate of Origin ([DCO](#dco)). | ||
- test locally any new feature or change. | ||
|
||
Maintainers will review and give feedback on pull requests. | ||
|
||
___ | ||
|
||
### Your First Contribution | ||
|
||
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](https://github.com/theupdateframework/python-tuf/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), or simply ask an owner for suggestions on [channel](#slack-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](#dco) in git. | ||
|
||
#### Areas you can start working on: | ||
|
||
- [Documentation](https://github.com/theupdateframework/theupdateframework.io/) 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](https://github.com/theupdateframework/python-tuf/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) tag. | ||
- Just ask on the [channel](#slack-channel) for suggestions. | ||
|
||
#### If you want to work on a new idea of relatively small scope: | ||
- Submit an issue describing your proposed change to the [repo](#tuf-repositories) in question. | ||
- For security issues follow [this](./reporting.md). | ||
- The repo owners will respond to your issue promptly. | ||
- If your proposed change is accepted, follow [Development guideline](https://github.com/secure-systems-lab/lab-guidelines/blob/master/dev-workflow.md). | ||
- Submit a pull request containing a tested change. | ||
|
||
___ | ||
|
||
### DCO | ||
Contributors must indicate acceptance of the [Developer Certificate of Origin](https://developercertificate.org/) by appending a Signed-off-by: Your Name <[email protected]> to each git commit message or use `-s` tag with `git commit`. | ||
|
||
____ | ||
|
||
### TUF Repositories | ||
h4l0gen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [python-tuf](https://github.com/theupdateframework/python-tuf) (this repository is a reference implementation written in Python) | ||
- [specification](https://github.com/theupdateframework/specification/) (The Update Framework specification) | ||
- [theupdateframework.io](https://github.com/theupdateframework/theupdateframework.io/) (Website assets for TUF) | ||
- [community](https://github.com/theupdateframework/community) (Community Repository of TUF) | ||
- [taps](https://github.com/theupdateframework/taps) (TUF Augmentation Proposals (TAPs)) | ||
- [tuf-on-ci](https://github.com/theupdateframework/tuf-on-ci) (A TUF repository and signing tool) | ||
- [rust-tuf](https://github.com/theupdateframework/rust-tuf) (Rust implementation of The Update Framework (TUF)) | ||
- [go-tuf](https://github.com/theupdateframework/go-tuf) (Go implementation of The Update Framework (TUF)) | ||
- [tuf-js](https://github.com/theupdateframework/tuf-js) (JavaScript implementation of The Update Framework (TUF)) | ||
___ | ||
|
||
### Slack channel | ||
Join us on the [#TUF](https://cloud-native.slack.com/archives/C8NMD3QJ3) channel on [CNCF Slack](https://slack.cncf.io/). | ||
|
||
___ | ||
|
||
### Mailing list | ||
Join us via the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework). | ||
___ | ||
### Community meeting | ||
- 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 | ||
|
||
____ | ||
### Governance | ||
Understand our [governance](https://github.com/theupdateframework/specification/blob/master/GOVERNANCE.md). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.