Skip to content

Consider to add best practices for writing a good README file

After watching the FOSDEM 2025 lightning talk "How to Write a Killer README", I think this is something that should be shared with our community and incorporated either directly in the Eclipse Handbook or by referencing an external guide.

The Handbook references a few things that should be mentioned in a README, but it's spread out over different sections:

A specific section about a good README could contain the following best-practices:

  • Explain what the purpose of a good README is, in general
  • What it should contain, e.g.
    • What does the project do? What does it NOT do?
    • How is the project different from other similar projects
    • Describe ideal use cases
    • How do people use the project (social proof) / examples
    • How to get started (easily)
    • Link to supporting organizations / companies
    • Link to contributing guide
    • Link to security related topics (how to report a vulnerability, etc)
    • Link to communication channels
    • Legal links
  • Must-haves vs. nice-to-haves
  • Eclipse-specific standards (e.g. legal documents)
  • Links to projects that already have good README files