Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Replace local contrib docs with a CONTRIBUTING.md link
CONTRIBUTING.md (which we got from project-template in be21fe9, *: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). I've copy/pasted the CONTRIBUTING.md content for issues and the mailing list into the README at Stephen's request [2], turning "Issues" into a link in the process. I've left it as a non-link in CONTRIBUTING.md to stay closer to the upstream project-template, but wouldn't have a problem making it a link there to if the maintainers preferred that. Personally I don't have a problem with requiring readers to click through to CONTRIBUTING to get this information, but I'm not a maintainer. I am slightly concerned that the copy/pasted discussion channel information is even further from the security-disclosure section (for a paranoid approach, see [3]), but I'll leave addressing that or not up to the maintainers as well. [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ [2]: opencontainers#9 (comment) [3]: opencontainers/project-template#57 Signed-off-by: W. Trevor King <[email protected]>
- Loading branch information