docs: add a section suggesting gifs for pr reviews #6974
Conversation
|
Thanks for the PR, @sfavello! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Sorry this took so long to review @sfavello - it slipped by me. But I really like it!
Just suggesting a bit of touching up to match the existing style: one sentence per line and removing a couple duplicated points. What do you think?
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6974 +/- ##
==========================================
+ Coverage 87.37% 87.38% +0.01%
==========================================
Files 386 386
Lines 13195 13193 -2
Branches 3867 3867
==========================================
Hits 11529 11529
+ Misses 1300 1298 -2
Partials 366 366
Flags with carried forward coverage won't be shown. Click here to find out more. |
PR Checklist
Overview
Added a suggestion section in the pull request docs with a section in adding gifs to PR reviews. I wasn't sure if I should add a new section called suggestions or put it below the first section. I was worried that the first section might become too verbose and that it might be better to break it up this way. I can definitely change/switch it to however is best though, no worries. Just wanted to say that I thought this was a great idea. Adding gifs to PR reviews can really make a difference, imho.