[PATCH] D59108: [Docs] Add top level CONTRIBUTING.md.

[Florian Hahn via llvm-commits]

> On Mar 7, 2019, at 1:58 PM, Tanya Lattner <tanyalattner at llvm.org> wrote:
> 
> The LLVM Project has not officially moved to GitHub yet and I would like to avoid fragmenting the project by having documentation in multiple places or done in different ways. There does need to be a discussion about what the best steps forward are in terms of documentation, bug tracker, etc. In regards to documentation, I have been looking for someone to help drive this topic as we need to do a cost/benefit tradeoff, explore some issues and determine what the best next steps are. If someone is interested in work on this, please let me know. I am happy to contribute information on what we do now and what is working and what is not.
> 
> -Tanya
> 
>> On Mar 7, 2019, at 1:21 PM, Renato Golin via Phabricator <reviews at reviews.llvm.org> wrote:
>> 
>> rengolin added a comment.
>> 
>> 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.
>> 
>> 


Thanks Tanya & Renato! I agree we should not fragment the documentation and CONTRIBUTING.md would only makes sense once LLVM officially moves to Github. I think CONTRIBUTING.md is a bit special in a way similar to README.md. They are treated in a special way by Github’s UI, but their major benefit is for projects using pull requests and/or Github issues, which is not the case right now. 

The main intention was to make the contributing information easier to discover. Maybe something like adding a link to http://www.llvm.org/docs/Contributing.html <http://www.llvm.org/docs/Contributing.html> to llvm.org <http://llvm.org/> would be better. And/Or add a link to CONTRIBUTING.md that just points to the docs

Cheers,
Florian
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190308/e6fd2641/attachment.html>