[core-workflow] Reviewing/updating the README for GitHub migration?
Brett Cannon
brett at python.org
Sat Apr 23 11:11:54 EDT 2016
On Fri, 22 Apr 2016 at 21:16 Nicholas Chammas <nicholas.chammas at gmail.com>
wrote:
> On Fri, Apr 22, 2016 at 11:40 PM Nick Coghlan <ncoghlan at gmail.com> wrote:
>
>> The reason I suggest that is that with the way code hosting services like
>> GitHub work, the README changes from something people may read for local
>> development after they've already cloned the repo to instead being the main
>> landing page for the repo.
>>
>> That means it becomes a good place to point out things like:
>>
>> - the location of the main dev guide
>> - the issue tracker
>> - the communications channels
>> - the PSF CLA (and the need to sign it for non-trivial contributions)
>>
>
> I wonder if some of these bits of information could go in a GitHub pull
> request template:
>
> https://github.com/blog/2111-issue-and-pull-request-templates
>
> That way they get presented to the contributor as soon as they hit the
> "new pull request" button.
>
My expectation is that the README will get tweaked and we will add a
CONTRIBUTING file. As for PR templates, that's going to depend on what kind
of workflow we end up with in terms of reviewing.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/core-workflow/attachments/20160423/9b31875e/attachment-0001.html>
More information about the core-workflow
mailing list