jaegertracing/jaeger

Audit and align governance, contribution, and security docs with CNCF guidelines

Open

#5,363 opened on Apr 16, 2024

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Go (18,974 stars) (2,326 forks)batch import
help wanted

Description

TAG Security has prepared Security Guidelines for new projects on contribute.cncf.io that are worth reviewing to refresh and refamiliarize your project’s configuration and settings. There are also a variety of templates available to assist projects in bootstrapping any governance structure or process they may currently be missing. As your project grows, we encourage projects to leverage the TAG Contributor Strategy’s contributor ladder framework to create structure, expectations, and clear roles and responsibilities for welcoming and inviting contributors to take on more leadership roles within a project. Migrating to this framework can support projects and proactively manage contributions without creating or embellishing a sense of urgency.

Contributor guide

Tech stack
None
Domain
documentationsecurity
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
CNCF guidelines knowledgeProject documentation familiarityGitHub skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the CNCF Security Guidelines and templates linked in the issue description. Compare Jaeger's existing governance, contribution, and security documentation against these guidelines. Identify gaps and propose changes in a new pull request. Existing docs are likely in the repository's docs/ or CONTRIBUTING.md files.