Documentation

Recommended documents

A project should contain the following documents:

• README

• CONTRIBUTING

• CODE_OF_CONDUCT

• A CHANGELOG (if the project includes multiple packages or similar, then one CHANGELOG per package may be more appropriate)

The documents should be easily accessible and discoverable, ideally by being put in standard locations.

The content of these documents is largely up to the project contributors, but we include some additional policies below In the following, when we say that a document should include information, this can either mean it includes it directly, or that it clearly links to where it can be found.

README

The project README should include any information that is necessary according to the governance policy.

CODE OF CONDUCT

Individual projects SHOULD use the default Code of Conduct in this repository, either by copying it or creating a CODE_OF_CONDUCT document that just links to it.