Closed stefannibrasil closed 2 years ago
hi @stefannibrasil! thanks for contributing!
I can answer at least one of your questions -- relating to CHANGELOG.md
stuff.
We use a format based on Keep A Changelog. The important things to note are:
main (unreleased)
heading* [<FEATURE | BUGFIX | CHORE>: Description of changes](github.com/link/to/pr)
As far as a good Skunk Score, I'm not really sure, but perhaps @etagwerker could help answer that one?
Merging #88 (b50c5fd) into main (507a725) will not change coverage. The diff coverage is
n/a
.:exclamation: Current head b50c5fd differs from pull request most recent head cf59df8. Consider uploading reports for the commit cf59df8 to get more accurate results
@@ Coverage Diff @@
## main #88 +/- ##
=======================================
Coverage 98.26% 98.26%
=======================================
Files 25 25
Lines 462 462
=======================================
Hits 454 454
Misses 8 8
:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more
@kindoflew @bronzdoc thank you for your review! I added more details about the Changelog.
@etagwerker do you have any thoughts on adding a "healthy" SkunkScore to add as an example for people to compare their current score with?
ping @etagwerker :shipit:
@kindoflew @stefannibrasil At this point I don't have an answer for that... I created an issue to improve this area of the gem: https://github.com/fastruby/skunk/issues/95
I've been slowly uploading scores to http://skunk.fastruby.io to get a sense of "healthy" skunk scores in real projects. But I don't have any conclusive data yet...
We really appreciate your contribution @stefannibrasil! I apologize for the delay, I think this is good to go and we can improve it later when we tackle https://github.com/fastruby/skunk/issues/95
The README now contains steps to generating the code coverage report, how to use the SkunkScore as a refactoring guide, and a separate Contributing guide. I also cleaned up a bit the skunk report to help people focus on what matters. It's my first time opening a Pull Request here, curious to see your thoughts!
I have a couple of questions of things I'd like to add in the README:
Thanks!
I will abide by the code of conduct.