Re: [PATCH v1] Configure Git contribution guidelines for github.com

From: Jeff King <peff@peff.net>
Date: Jun 10, 2017, 07:35 UTC
Message-ID: <20170610073521.ewjzvtpha3xgoe6z@sigill.intra.peff.net>
In-Reply-To: <20170609170357.GE21733@aiede.mtv.corp.google.com>

On Fri, Jun 09, 2017 at 10:03:57AM -0700, Jonathan Nieder wrote:

> Would putting a PULL_REQUEST_TEMPLATE and CONTRIBUTING in the
> top-level directory work?  If I'm reading
> https://help.github.com/articles/setting-guidelines-for-repository-contributors/#adding-a-contributing-file
> correctly then it seems to say the ".github/" prefix is optional.

Yes, that should work. The ".github" option is there if you don't want the cruft at your top-level. I don't mind CONTRIBUTING, but PULL_REQUEST_TEMPLATE is kind of gross. :)

> I also find the long source lines hard to read.  Can you say more
> about how broken lines render in the github.com web interface?  I
> would have expected github's markdown renderer to behave like others
> and cope with line wrapping.

GitHub-Flavored Markdown treats newlines as a line break in the rendered output, unlike the original Markdown implementation. I don't like that myself, but it was done in the early days after seeing how many people accidentally butchered their formatting because they expected the output to look more like what they typed.

-Peff