Skip to content
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

Refresh the README.md #327

Merged
merged 6 commits into from
Dec 8, 2022
Merged

Refresh the README.md #327

merged 6 commits into from
Dec 8, 2022

Conversation

mamercad
Copy link
Contributor

@mamercad mamercad commented Dec 7, 2022

Fix the broken Slack badge image, remove contractions, make grammar changes, write OS names and versions more consistently, show long options in commands, etc. I'll add markdown linting in another PR shortly.

@pull-request-size pull-request-size bot added the size/M PR that changes 30-99 lines. Good size to review. label Dec 7, 2022
@mamercad mamercad marked this pull request as draft December 7, 2022 13:31
@pull-request-size pull-request-size bot added size/L PR that changes 100-499 lines. Requires some effort to review. and removed size/M PR that changes 30-99 lines. Good size to review. labels Dec 7, 2022
@mamercad mamercad marked this pull request as ready for review December 7, 2022 13:34
Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

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

I'm 👍 for the Readme refresh, but 👎 for Markdown linting as that's another uneeded check that might block a PR or change.

I think markdown linting makes sense for the projects where every file is documentation, but not for a single README.md when the frequency of change is low and the chance of breaking a Markdown file is even lower (they just work!).
Let's avoid utilizing computing resources in this case 🍏

@mamercad
Copy link
Contributor Author

mamercad commented Dec 7, 2022

I'm 👍 for the Readme refresh, but 👎 for Markdown linting as that's another uneeded check that might block a PR or change.

I think markdown linting makes sense for the projects where every file is documentation, but not for a single README.md when the frequency of change is low and the chance of breaking a Markdown file is even lower (they just work!). Let's avoid utilizing computing resources in this case 🍏

Sure, I'll push without the workflow shortly.

@pull-request-size pull-request-size bot added size/M PR that changes 30-99 lines. Good size to review. and removed size/L PR that changes 100-499 lines. Requires some effort to review. labels Dec 7, 2022
@mamercad
Copy link
Contributor Author

mamercad commented Dec 7, 2022

I'm 👍 for the Readme refresh, but 👎 for Markdown linting as that's another uneeded check that might block a PR or change.
I think markdown linting makes sense for the projects where every file is documentation, but not for a single README.md when the frequency of change is low and the chance of breaking a Markdown file is even lower (they just work!). Let's avoid utilizing computing resources in this case 🍏

Sure, I'll push without the workflow shortly.

Done, I rebased as well so the history should be clean.

@mamercad mamercad requested a review from arm4b December 7, 2022 13:58
@mamercad
Copy link
Contributor Author

mamercad commented Dec 7, 2022

In the spirit of not running workflows unnecessarily, I'm noticing that the build workflow is running (for this README.md update, we should probably fix that).

Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

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

Thanks for the refresh!

@arm4b arm4b merged commit b9673f5 into StackStorm:master Dec 8, 2022
@mamercad mamercad deleted the update-readme branch December 8, 2022 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M PR that changes 30-99 lines. Good size to review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants