Closed gautamarora closed 6 years ago
Merging #399 into master will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## master #399 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 10 10
Lines 177 177
Branches 50 50
=====================================
Hits 177 177
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update 29c5afd...1dc46dd. Read the comment docs.
What: This PR makes minor updates to the documentation for consistent conventions following the new opensource-check project.
p.s. the opensource-check project is very new, so if you have feedback for that, I am happy to update the tool
Why: The
opensource-check
makes it easy for maintainers to quickly review the conventions their project is following, and to remain consistent. It makes it easy for new users as they discover the repository of a new project. e.g. the downshift project requires no changes as its already consistent, butglamorous
has slight deviations.How: These changes were made by running the
opensource-check
tool against theglamorous
project and fixing the 2 reported issues.If you would like to try out these changes locally:
npx @condenast/opensource-check --path ./glamorous
Checklist:
Here is the screenshot from running the check after the changes: