Skip to content

Conversation

Grinnz
Copy link
Contributor

@Grinnz Grinnz commented Oct 18, 2019

These changes are primarily to POD and comments.

The "Merging from a branch via GitHub" section is removed because it's not really relevant when GitHub is the standard repository.

I'm not sure what to do with the "A note on camel and dromedary" section in perlgit or the "Read access via rsync" section in perlhack.

References to cloning via HTTP being "slower" were removed as I see no evidence of this with the GitHub repository.

Additional updates are needed to reference the GitHub pull request workflow, I may work on this in a future patch.

Updating documentation to reference using GitHub to submit bug reports (other than the metadata entry) is not part of this patch and will be a significant undertaking that needs to start with the perlbug utility.

@Grinnz
Copy link
Contributor Author

Grinnz commented Oct 18, 2019

Forgot to mention, this should obviously wait until the migration is complete.

@atoomic
Copy link
Member

atoomic commented Oct 19, 2019

I think we should remove the A note on camel and dromedary section from pod/perlgit.pod

@Corion
Copy link

Corion commented Oct 19, 2019

This will also need the additional fix to Porting/corelist.pl, where a check for upstream / bug tracker rt.perl.org is made. I guess you'll want to add whatever becomes the canonical upstream URL there as well, like maybe https://github.com/Perl/perl5/issues:

  next if $bug_tracker eq "'https://github.com/Perl/perl5/issues'";

@Grinnz
Copy link
Contributor Author

Grinnz commented Oct 19, 2019

@Corion added, thanks

@Grinnz
Copy link
Contributor Author

Grinnz commented Oct 19, 2019

Removed the perlgit section on camel and dromedary

Before pushing any change to a maint version, make sure you've
satisfied the steps in L</Committing to blead> above.

=head2 Merging from a branch via GitHub
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is cool but we probably need a TODO to add something about PRs in github

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to do this as a separate PR, the references to perlbug are extensive.

Fortunately, there is a way to get your change smoke-tested on various
OSes: push it to a "smoke-me" branch and wait for certain automated
smoke-testers to report the results from their OSes.
A "smoke-me" branch is identified by the branch name: specifically, as
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually pull requests will smoke.

@Grinnz
Copy link
Contributor Author

Grinnz commented Oct 20, 2019

Removed the 'Committing your changes' section from perlgit since it contains the same information as the preceding section, aside from a link to perlhack that I added to the preceding section.

@toddr toddr merged commit 47ef154 into Perl:blead Oct 20, 2019
@Grinnz Grinnz deleted the git_docs_github branch October 26, 2019 17:37
steve-m-hay pushed a commit that referenced this pull request Oct 27, 2019
…ical repository (#1186)

* Update repository and bugtracker URLs to GitHub in makemeta

regen META files

* Update POD and comments to reference GitHub as canonical repository

* Update Porting/corelist.pl to recognize GitHub issue tracker

* remove "A note on camel and dromedary"

* Remove redundant 'Committing your changes' section

(cherry picked from commit 47ef154)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants