-
Notifications
You must be signed in to change notification settings - Fork 18
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 docs examples with latest dependency versions #20
Conversation
Hello @Spreeuw 😄 I created a pull request, as you requested. Would you like to review this change? I'll give you a bit of time to answer/review, until Wednesday August 18; then, I'll merge the changes. |
Please note that there are some changes to the README in #19. The changes there match the current pull request. 👍🏼 |
README.md
Outdated
@@ -25,12 +25,12 @@ steps: | |||
- uses: actions/checkout@v2 | |||
|
|||
- name: Auto Minify | |||
uses: nizarmah/auto-minify@master | |||
uses: nizarmah/auto-minify@v2.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.
Unless you have a specific reason to restrict it to .0
I would suggest to just use @v2
(same for the other occurrences)
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.
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'm not sure that answers my question 😉
If you follow SemVer, v2.1
would not have any breaking changes compared to v2.0
, so then it would make sense to use @v2
in your docs. If you do not follow SemVer and v2.1
is a breaking change... Then you should indeed use @v2.0
in your docs.
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.
Oh! @Spreeuw thanks for the clarification 👀 I've updated it to @v2
since v2.1
isn't a breaking change.
I'll read more about semantic versioning; I wasn't aware of it so thanks for pointing me in the right direction 😃
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.
🚀
@nizarmah you mentioned here that you were planning to release v2.1 last Wednesday, is anything holding up the release? |
@Spreeuw Yeah! Sorry about that. I was having power issues in my country, which obstructed some of my plans during those times I'm available for my open source work. I'm doing that in the next hour. It's a high priority on my list 👍🏼 |
Great, thank you so much for the release! One nitpick: It's more common to include the version number in the release name/title, like github themselves do too: That also addresses another nitpick:
but it also includes:
(you may or may not want to include the docs change, that's up to you of course) |
That's good to know! Thank you! I never knew what to include in the Release Title. And lately due to my power/connection issues in my country, I haven't had the chance to educate myself on those aspects 😔
Yeah, I tend to forget that other people are using my tools. I love open source, but I'm not used to having an audience 😅 I often leave my changelog empty, sadly. I'll do my best to take things more seriously now that my tools are being used by others. Also, I really appreciate your help with this. There's a lot of stuff I don't know and I haven't been reading about because I haven't had much of an audience. Your comments are really helping push me into the right direction, during this time. At the moment, unfortunately, I've been spread thin across real world issues, but once those are in the clear, I'll have more time to deliver better quality in my repositories 😃 |
No worries at all, I really appreciate your work on this, just trying to contribute! |
I'm glad you are @Spreeuw 🤗 Hope you have a wonderful day btw! 🚀 |
Updates the docs examples in the README with the latest dependency versions, as suggested in #18.