Maintain documentation with a single source of truth to prevent inconsistencies and reduce maintenance burden. When information exists elsewhere, link to it rather than duplicating content. This applies to code of conduct references, governance documents, and API documentation.
Maintain documentation with a single source of truth to prevent inconsistencies and reduce maintenance burden. When information exists elsewhere, link to it rather than duplicating content. This applies to code of conduct references, governance documents, and API documentation.
For example:
// Good - Links to the source
The code of conduct is located in [CODE_OF_CONDUCT.md](https://github.com/expressjs/.github/blob/HEAD/CODE_OF_CONDUCT.md)
// Bad - Duplicates content that might get out of sync
# Code of Conduct
Our project is committed to providing a welcoming community...
When writing documentation:
By following these practices, documentation stays current, accurate, and easier to maintain as the project evolves. When documentation must exist in multiple locations, establish clear processes for synchronization.
Enter the URL of a public GitHub repository