theupdateframework / theupdateframework/theupdateframework.io
Add separate `contributing` page for new users in `Community` on website.
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 25
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
As per CNCF assessment To fulfill this criteria we must need Contributing and Your First Contribution section on our website. We can give general instructions here as
- Link of Contributing.md
- Ask them to work on existing issue first (e.g. good first issues)
- Report any security related issue here
As an example we can see helm project's Your First Contribution section.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the website's existing Community section, the linked Contributing.md, and Helm's “Your First Contribution” example. Done means the site has a separate Contributing page in Community with general guidance, a Contributing.md link, advice to choose an existing issue, and the security-reporting link, covering the CNCF criterion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100