New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Dist:Zilla #36

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@athos-ribeiro

athos-ribeiro commented May 8, 2015

Installation instructions were outdated

@stevan

This comment has been minimized.

Show comment
Hide comment
@stevan

stevan May 8, 2015

Owner

Dist::Zilla should only be required if you are installing from GitHub or planning to do development work on the module itself ("author" time dependency). If installed from CPAN it should not be required. Can you explain the issue that lead you to submit this patch?

Thanks,

Stevan

Sent from my iPhone

On May 8, 2015, at 4:02, Athos Ribeiro notifications@github.com wrote:

Installation instructions were outdated

You can view, comment on, or merge this pull request online at:

#36

Commit Summary

Update documentation for Dist:Zilla
File Changes

M README.md (24)
Patch Links:

https://github.com/stevan/promises-perl/pull/36.patch
https://github.com/stevan/promises-perl/pull/36.diff

Reply to this email directly or view it on GitHub.

Owner

stevan commented May 8, 2015

Dist::Zilla should only be required if you are installing from GitHub or planning to do development work on the module itself ("author" time dependency). If installed from CPAN it should not be required. Can you explain the issue that lead you to submit this patch?

Thanks,

Stevan

Sent from my iPhone

On May 8, 2015, at 4:02, Athos Ribeiro notifications@github.com wrote:

Installation instructions were outdated

You can view, comment on, or merge this pull request online at:

#36

Commit Summary

Update documentation for Dist:Zilla
File Changes

M README.md (24)
Patch Links:

https://github.com/stevan/promises-perl/pull/36.patch
https://github.com/stevan/promises-perl/pull/36.diff

Reply to this email directly or view it on GitHub.

@athos-ribeiro

This comment has been minimized.

Show comment
Hide comment
@athos-ribeiro

athos-ribeiro May 8, 2015

Oh, I see, the README information was probably for tarball distribution, right?

Well, I got your dist for cpan PR-Challenge (http://neilb.org/2014/11/29/pr-challenge-2015.html), and 1st thing I noticed in the repo was the absence of instructions for using Dist::Zilla! :)

athos-ribeiro commented May 8, 2015

Oh, I see, the README information was probably for tarball distribution, right?

Well, I got your dist for cpan PR-Challenge (http://neilb.org/2014/11/29/pr-challenge-2015.html), and 1st thing I noticed in the repo was the absence of instructions for using Dist::Zilla! :)

@stevan

This comment has been minimized.

Show comment
Hide comment
@stevan

stevan May 8, 2015

Owner

Yes, the README is meant to be distributed with the module.

If you are looking for something to work on related to this module you might want to take a look at this older pull-request (#32). It has been closed, but there is likely some code improvements that could be pulled from it.

You could also look over the RT queue (https://rt.cpan.org/Public/Dist/Display.html?Name=Promises) many of these issues could probably be closed, but again there might be some good parts within them that can be applied.

Additionally, you could look into some of the other Promise modules (https://metacpan.org/pod/Promises6 and https://metacpan.org/pod/AnyEvent::Promise in particular) and see if there is anything useful in their implementations that could be merged back to this module.

Of course if you have any ideas yourself about improvements, I am always open to suggestions as well.

And lastly, thanks for participating in the CPAN PR-challange! :)

  • Stevan
Owner

stevan commented May 8, 2015

Yes, the README is meant to be distributed with the module.

If you are looking for something to work on related to this module you might want to take a look at this older pull-request (#32). It has been closed, but there is likely some code improvements that could be pulled from it.

You could also look over the RT queue (https://rt.cpan.org/Public/Dist/Display.html?Name=Promises) many of these issues could probably be closed, but again there might be some good parts within them that can be applied.

Additionally, you could look into some of the other Promise modules (https://metacpan.org/pod/Promises6 and https://metacpan.org/pod/AnyEvent::Promise in particular) and see if there is anything useful in their implementations that could be merged back to this module.

Of course if you have any ideas yourself about improvements, I am always open to suggestions as well.

And lastly, thanks for participating in the CPAN PR-challange! :)

  • Stevan
@yanick

This comment has been minimized.

Show comment
Hide comment
@yanick

yanick May 10, 2017

Collaborator

As Stevan said, the README is for the final cpan disto. I won't merge this ticket in, but thanks for submitting it!

Collaborator

yanick commented May 10, 2017

As Stevan said, the README is for the final cpan disto. I won't merge this ticket in, but thanks for submitting it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment