ossf / ossf/package-analysis

OpenSSF Documentation Updates

Open
#1,125 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
912
Forks
74
PR merge metrics
No merged PRs in 30d

Description

As a technical initiative hosted within the OpenSSF, the project needs to participate in the TAC Project Lifecycle process and its Gives and Gets.

To do this we need to complete the submission process as outlined here in order to establish and document the project's lifecycle status with the TAC. Templates for submitting can be found here: https://github.com/ossf/tac/tree/main/process/templates, and examples of other projects' documents can be found here https://github.com/ossf/tac/tree/main/process/project-lifecycle-documents.

In addition to the TAC documentation, here are another couple of recommendations for this project for community documentation:

Consider adding a CHARTER.md to the repository like this example.

Consider adding a MAINTAINERS file to the repository like this example or listing the maintainers in the readme or a contributing or governance file.

Contributor guide

Open the contributing guide

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.

Research direction

Read the linked OpenSSF TAC project-lifecycle submission process, templates, and example project-lifecycle documents first. Then identify the repository documents needed for the submission, along with a CHARTER.md and MAINTAINERS file or equivalent maintainer listing. Done means the lifecycle status and community-maintainer information are documented in the repository.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.