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

docs: add READMEs to packages #2986

Merged
merged 7 commits into from
Oct 26, 2022
Merged

docs: add READMEs to packages #2986

merged 7 commits into from
Oct 26, 2022

Conversation

georgexu99
Copy link
Contributor

@georgexu99 georgexu99 commented Oct 25, 2022

Co-authored-by: Keeley Hammond vertedinde@electronjs.org

This PR adds more detailed READMEs to each Forge module.

Deployed live here at https://add-readmes--marvelous-choux-77d0b7.netlify.app/

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable).
  • The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

@codecov
Copy link

codecov bot commented Oct 25, 2022

Codecov Report

Merging #2986 (f6b2d36) into main (8fa40d4) will decrease coverage by 0.47%.
The diff coverage is n/a.

❗ Current head f6b2d36 differs from pull request most recent head 622649b. Consider uploading reports for the commit 622649b to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2986      +/-   ##
==========================================
- Coverage   74.27%   73.80%   -0.48%     
==========================================
  Files          67       67              
  Lines        2185     2168      -17     
  Branches      438      436       -2     
==========================================
- Hits         1623     1600      -23     
- Misses        354      361       +7     
+ Partials      208      207       -1     
Impacted Files Coverage Δ
packages/maker/snap/src/MakerSnap.ts 93.33% <0.00%> (-6.67%) ⬇️
packages/plugin/base/src/Plugin.ts 57.14% <0.00%> (-5.36%) ⬇️
packages/maker/dmg/src/MakerDMG.ts 95.00% <0.00%> (-5.00%) ⬇️
packages/maker/wix/src/MakerWix.ts 81.81% <0.00%> (-4.55%) ⬇️
packages/maker/deb/src/MakerDeb.ts 90.90% <0.00%> (-4.55%) ⬇️
packages/maker/rpm/src/MakerRpm.ts 90.90% <0.00%> (-4.55%) ⬇️
packages/publisher/base/src/Publisher.ts 62.50% <0.00%> (-4.17%) ⬇️
packages/maker/base/src/Maker.ts 69.69% <0.00%> (-3.84%) ⬇️
packages/maker/appx/src/MakerAppX.ts 60.34% <0.00%> (-1.73%) ⬇️
packages/maker/squirrel/src/MakerSquirrel.ts 76.19% <0.00%> (-1.09%) ⬇️
... and 42 more

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 8fa40d4...622649b. Read the comment docs.

@VerteDinde VerteDinde marked this pull request as ready for review October 25, 2022 18:58
@VerteDinde VerteDinde merged commit 8b78d70 into main Oct 26, 2022
@VerteDinde VerteDinde deleted the add-READMEs branch October 26, 2022 22:30
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.

3 participants