Page MenuHomePhabricator

[Docs] Add top level CONTRIBUTING.md.
Needs ReviewPublic

Authored by fhahn on Mar 7 2019, 12:59 PM.

Details

Summary

This basically is llvm/docs/Contributing.rst converted to Markdown, so
we can use it as Contributing.md for Github. That's what will show up
as 'contributing guidelines' on Github:

https://github.blog/2012-09-17-contributing-guidelines/

This needs to be added to the top-level directory in the repo (like
README.md). If we decide to use it, we can probably retire
llvm/docs/Contributing.rst.

Event Timeline

fhahn created this revision.Mar 7 2019, 12:59 PM
Herald added a project: Restricted Project. · View Herald TranscriptMar 7 2019, 12:59 PM
Herald added a subscriber: jdoerfert. · View Herald Transcript

I'm not against moving docs there but I think there should be a conversation about the broader subject of docs, github, wiki, etc.

Last time we discussed the media we use was years ago and a lot has changed since. Not to mention the broken infea we have to validate and build docs, that would come for free from github.

I personally recommend we do a whole move, possibly keeping them in docs but linking from the root tree. We have too many docs to move down, though, contributing is a standard root doc anyway.