-
Notifications
You must be signed in to change notification settings - Fork 3
Description
A project has documentation. These files are usually listed in the top level of a repository.
LICENSE: By definition, every open source project must have an open source license. If the project does not have a license, it is not open source.
YES/NO:
README: The README is the instruction manual that welcomes new community members to the project. It explains why the project is useful and how to get started.
YES/NO:
CONTRIBUTING: Whereas READMEs help people use the project, contributing docs help people contribute to the project. It explains what types of contributions are needed and how the process works. While not every project has a CONTRIBUTING file, its presence signals that this is a welcoming project to contribute to. A good example of an effective Contributing Guide would be the one from Codecademy’s Docs repository.
YES/NO:
CODE_OF_CONDUCT: The code of conduct sets ground rules for participants’ behavior associated and helps to facilitate a friendly, welcoming environment. While not every project has a CODE_OF_CONDUCT file, its presence signals that this is a welcoming project to contribute to.
YES/NO:
Other documentation: There might be additional documentation, such as tutorials, walkthroughs, or governance policies, especially on bigger projects like [Astro Docs](https://docs.astro.build/en/contribute/#contributing-to-docs).