Requirements for public repos

This page is now obsolete. It is superseded by OEP-55: Project Maintainers.


(This is a proposal, comments welcome.)

If a GitHub repository is public, it must have:

A public repo should have:

  • A changelog

  • A link to documentation. There’s a variety of docs that could be available, described in OEP-19: Developer Documentation.

  • Information about how to report issues.

  • Where to go for help with the repo.

A public repo accepting contributions should have:

  • A pull request template