> On Jan. 25, 2015, 2:40 a.m., Joshua Cohen wrote: > > 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." > > Jeffrey Schroeder wrote: > So reviewboard epic fails here and git isn't super obvious. > CONTRIBUTING.md is a symlink to docs/contributing.md. > > [jeff@omniscience aurora] (add-contributing)$ git show HEAD > commit 6d7368710dd87016e39c9c6160c43a39ef30d21d > Author: Jeff Schroeder <[email protected]> > Date: Sat Jan 24 15:51:26 2015 -0600 > > Add CONTRIBUTING.md so github shows a link to it before opening a PR > > diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md > new file mode 120000 > index 0000000..d0fcfe9 > --- /dev/null > +++ b/CONTRIBUTING.md > @@ -0,0 +1 @@ > +docs/contributing.md > \ No newline at end of file > > [jeff@omniscience aurora] (add-contributing)$ ls -l CONTRIBUTING.md > lrwxrwxrwx. 1 jeff jeff 20 Jan 24 15:51 CONTRIBUTING.md -> > docs/contributing.md > > [jeff@omniscience aurora] (add-contributing)$ git status > On branch add-contributing > nothing to commit, working directory clean > > > So this change simply docs/contributing.md into the root of the project > so it shows up when someone tries to open a pull request. > > Try "rbt patch 30249" to see for yourself :)
Ahh, great, that's perfect. I should have realized, I just added a symlink a few weeks back and noticed RB did the same thing in that case, but didn't put 2+2 together here! - Joshua ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/30249/#review69552 ----------------------------------------------------------- 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 > >
