git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: Lars Schneider <larsxschneider@gmail.com>,
	git@vger.kernel.org, gitster@pobox.com
Subject: Re: [PATCH v1] Configure Git contribution guidelines for github.com
Date: Sat, 10 Jun 2017 03:35:21 -0400	[thread overview]
Message-ID: <20170610073521.ewjzvtpha3xgoe6z@sigill.intra.peff.net> (raw)
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

  parent reply	other threads:[~2017-06-10  7:35 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-09 14:21 [PATCH v1] Configure Git contribution guidelines for github.com Lars Schneider
2017-06-09 16:18 ` Ævar Arnfjörð Bjarmason
2017-06-09 16:29   ` Lars Schneider
2017-06-10  1:44   ` Junio C Hamano
2017-06-09 17:03 ` Jonathan Nieder
2017-06-10  1:51   ` Junio C Hamano
2017-06-13  7:57     ` Lars Schneider
2017-06-10  7:35   ` Jeff King [this message]
2017-06-13  7:51     ` Lars Schneider
2017-06-10 12:48 ` Philip Oakley
2017-06-12 15:52   ` Junio C Hamano
2017-06-13  7:45     ` Lars Schneider
2017-06-15  8:09     ` Ævar Arnfjörð Bjarmason
2017-06-15 16:43       ` Junio C Hamano
2017-06-15 17:31         ` Andreas Heiduk
2017-06-15 17:59           ` Junio C Hamano
2017-06-13  7:48   ` Lars Schneider

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170610073521.ewjzvtpha3xgoe6z@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=larsxschneider@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).