Repository Expectations¶
Repositories should be usable by other members of the group without additional explanation.
Minimum Requirements¶
Every repository must include:
- A
README.mdthat clearly states what the project does. - Instructions for running or reproducing the project.
- Maintainer information (name and GitHub handle).
Standard¶
If another member cannot understand the purpose of the repository or run it without contacting you, the documentation is insufficient.