Reviewing/updating the README for GitHub migration?
By way of Twitter, I came across https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-te... today, and it made me realise something: we should probably add reviewing and potentially updating the README as part of the GitHub migration. 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) That's not a blocker task, I mainly wanted to bring up the link to Nadia's guide and the rest of the email is explaining why I think that's relevant to us even though we already have the developer guide :) Cheers, Nick. -- Nick Coghlan | ncoghlan@gmail.com | Brisbane, Australia
On Fri, Apr 22, 2016 at 11:40 PM Nick Coghlan <ncoghlan@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. Nick
On Fri, 22 Apr 2016 at 21:16 Nicholas Chammas <nicholas.chammas@gmail.com> wrote:
On Fri, Apr 22, 2016 at 11:40 PM Nick Coghlan <ncoghlan@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.
participants (3)
-
Brett Cannon -
Nicholas Chammas -
Nick Coghlan