----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/30249/#review69552 -----------------------------------------------------------
I think this is a great idea, it'll definitely help point people to ReviewBoard rather than opening pull requests. That said, as far as I can tell, Github has no special processing for including one markdown doc within another, so presumably this will render literally as the string "docs/contributing.md". Can you add a little bit more content to this file so that it says something like, "Please see [the contributing guidelines](docs/contributing.md) for details on how to contribute patches to Aurora." - Joshua Cohen On Jan. 24, 2015, 9:53 p.m., Jeffrey Schroeder wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/30249/ > ----------------------------------------------------------- > > (Updated Jan. 24, 2015, 9:53 p.m.) > > > Review request for Aurora. > > > Repository: aurora > > > Description > ------- > > Add CONTRIBUTING.md so github shows a link to it before opening a PR > > > Diffs > ----- > > CONTRIBUTING.md PRE-CREATION > > Diff: https://reviews.apache.org/r/30249/diff/ > > > Testing > ------- > > I accidentally opened a github pull request to fix a small documentation tyop > previously. Per the [github > documentation](https://github.com/blog/1184-contributing-guidelines), if you > have CONTRIBUTING.md in the root of the project, it will be shown before a > user ever opens a pull request. > > Probably makes sense to prevent people from opening pull requests in the > future. Note that this is simply a symlink to docs/contributing.md. > > > Thanks, > > Jeffrey Schroeder > >
