Add separate `contributing` page for new users in `Community` on website.

Open
#49 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
html
Domain
documentation

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.

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.

Dominant language
HTML
Stars
25
Forks
46
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from theupdateframework/theupdateframework.io

All issues in theupdateframework/theupdateframework.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.