Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.82 KB

README.md

File metadata and controls

28 lines (24 loc) · 1.82 KB

CQFN is the place where we keep experimental and not-yet-ready-for-production open source products. Even though our projects are experimental we expect their authors to maintain them with the highest quality, according to the best practices of open source community, including:

  • Your product must be somehow better than others on the market
  • Your README must list all known competitors and explain why they are worse
  • Actual version of repository is merged to primary branch (master or main)
  • Branch names are informative, it is either linked to a ticket or describes feature verbosely
  • Continuous integration is a must (use Travis or GitHub Actions)
  • Build automation and package management is a must
  • At least all public entry points are documented using proper documentation tools (javadoc, etc)
  • Static analysis is a must
  • Your release procedure must be automated either via @rultor or GitHub Actions
  • CONTRIBUTING.md must exist
  • Your README must look nice
  • Your membership in @cqfn must be "public" (edit here)
  • Your contribution discipline is exceptional
  • Your license must be MIT

Use one of our existing projects as an example.

When you are ready to add your project here, just email us.