-
Notifications
You must be signed in to change notification settings - Fork 24
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
Rewrite installation and invocation instructions using Composer #140
Conversation
697ca28
to
beea825
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I left a couple suggestions inline, let me know what you think.
beea825
to
40e67ca
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM :) Let's see what @samwilson has to say.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, reads well. I only have a tiny comment about the version number, and I was going to say that something should be added to the release process — but it's already mentioned in GOVERNANCE.md
. :-)
README.md
Outdated
"hamstar/Wikimate": "0.15.0" | ||
{ | ||
"require": { | ||
"hamstar/Wikimate": "^0.15.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't matter massively before 1.0, but I'd suggest writing this as the slightly more lenient ^0.15
. This is because (once the trailing zero becomes a 1 or whatever), if a project depends on two libraries that both depend on Wikimate, there's less chance of version conflicts. This doesn't really matter before 1.0, and anyway it's probably not that likely for multiple libraries to depend on Wikimate, so feel free to ignore this comment! :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't matter massively before 1.0, but I'd suggest writing this as the slightly more lenient
^0.15
. This is because (once the trailing zero becomes a 1 or whatever), if a project depends on two libraries that both depend on Wikimate, there's less chance of version conflicts. This doesn't really matter before 1.0, and anyway it's probably not that likely for multiple libraries to depend on Wikimate, so feel free to ignore this comment! :-)
Thanks, I made the change.
But I am sort of wondering if what you wrote applies more to ~1.0
rather than ^1.0
(1.0.0 will indeed be our next release).
Per the documentation my understanding is that ^1.0.0
will allow ">=1.0.0 <2.0.0" and is thus very lenient, while ~1.0.0
allows only ">1.0.0 <1.1.0" and thus indeed increases the risk of a version conflict (so ~1.0
would be better indeed). But I'm new to this, so open to enlightenment. :)
40e67ca
to
22d0ea4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll merge in a bit, but first will change the title of the PR to be in the imperative mood, like the commit messages (and unlike the |
This PR was prompted by this observation. Some of the text was copied from the AddWiki docs, I hope that is alright.
@samwilson, is this what you had in mind?