Skip to content

Clear and evolving contribution process & issue submission documentation #1865

@LexiNadolski

Description

@LexiNadolski

Context

For CNCF graduation, Flatcar must demonstrate:

  • A clearly defined and easily discoverable process for submitting issues and changes (bugs, features, PRs).
  • Comprehensive contributor documentation, with increasing detail and clarity as the project matures.

Currently, the main contribution and issue submission processes are documented in CONTRIBUTING.md and summarized in the README. The issue tracker and PR process are open and regularly reviewed. Ongoing efforts (#1817, #1791, #1816) further improve contributor onboarding, process documentation, and template clarity.


Goals

  • Ensure all users and contributors can easily find and understand how to submit issues, suggest changes, and contribute to Flatcar.
  • Continuously improve and expand contributor documentation in line with project growth and community needs.

Tasks / Next Steps

  • Audit all entry points (README, CONTRIBUTING.md, website, docs) for clear, up-to-date, and prominent contribution and issue submission instructions.
  • Cross-link documentation and templates for seamless navigation.
  • Update documentation to reflect maturing processes (e.g., onboarding, code review, decision-making, roles).
  • Collect and incorporate feedback from new and experienced contributors about the clarity and completeness of the process.
  • Summarize improvements and evidence here for CNCF graduation review.

References

Metadata

Metadata

Assignees

Labels

CNCF/gcaCNCFs Graduation Criteria Assessmentarea/CNCFkind/questionFurther information is requestedkind/taskA concrete programming / documentation task.

Type

Projects

Status

⚒️ In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions