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

Update README.md: added real world usage example #178

Merged
merged 2 commits into from Dec 11, 2022

Conversation

iamtodor
Copy link
Contributor

@iamtodor iamtodor commented Dec 3, 2022

I wrote a blog post with a demo repository about this plugin's configuration and usage. How do you think, might it be useful?
If the sentence could be rephrased in a better way please do so!

added blog post about this plugin's configuration and usage
@iamtodor iamtodor changed the title Update README.md Update README.md: added real world usage example Dec 3, 2022
@dorny
Copy link
Owner

dorny commented Dec 9, 2022

@iamtodor Thanks for writing this. I'm sure it will be useful. No need to rephrase anything :)
However, I would suggest two improvements:

  • Code snippets in the article still use the getsentry/paths-filter fork. It would be good to change it so it shows the use of action from the original repo - this one. It could lead other people into using the fork without realizing it and they would miss the improvement and bug fixes.
  • As a more general feedback, I strongly prefer when code snippets are included as the formatted text you can easily copy instead of images. Although the link to the demo repo partially fixes it. I'm not also very familiar with dev.to platform so if it's not possible there just ignore this point.

@iamtodor
Copy link
Contributor Author

@dorny thank you for pointing it out!

Code snippets in the article still use the getsentry/paths-filter fork

I absolutely forgot to change the screenshots, but now it's fixed :)

I strongly prefer when code snippets are included as the formatted text you can easily copy instead of images

Same for me. In this particular situation, I provided all the code in the repo as you mentioned. The reason for the screenshots is to highlight the specific strings/configuration. As you can see some strings are darker and some bright, this is done to catch the reader's attention.

@dorny dorny merged commit 4067d88 into dorny:master Dec 11, 2022
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.

None yet

2 participants