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

Generate Readme.md #1762

Merged
merged 22 commits into from
Oct 18, 2024
Merged

Generate Readme.md #1762

merged 22 commits into from
Oct 18, 2024

Conversation

jribbink
Copy link
Contributor

@jribbink jribbink commented Sep 20, 2024

Closes #1757

Description


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@jribbink jribbink changed the title Jribbink/readme Generate Readme.md Sep 20, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 26, 2024

Codecov Report

Attention: Patch coverage is 28.57143% with 25 lines in your changes missing coverage. Please review.

Project coverage is 28.47%. Comparing base (3a6202f) to head (8f9efc4).
Report is 10 commits behind head on master.

Files with missing lines Patch % Lines
internal/super/setup.go 0.00% 19 Missing ⚠️
internal/super/generator/file_template.go 62.50% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1762      +/-   ##
==========================================
- Coverage   29.69%   28.47%   -1.23%     
==========================================
  Files          94       95       +1     
  Lines        5182     6490    +1308     
==========================================
+ Hits         1539     1848     +309     
- Misses       3463     4462     +999     
  Partials      180      180              
Flag Coverage Δ
unittests 28.47% <28.57%> (-1.23%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jribbink jribbink added the Improvement Technical work without new features, refactoring, improving tests label Sep 26, 2024
@jribbink jribbink marked this pull request as ready for review October 18, 2024 21:00
Copy link
Contributor

@gregsantos gregsantos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lg2G. couple link suggestions

internal/super/generator/fixtures/README_no_deps.md Outdated Show resolved Hide resolved
internal/super/generator/fixtures/README_with_deps.md Outdated Show resolved Hide resolved
internal/super/generator/templates/README.md.tmpl Outdated Show resolved Hide resolved
Copy link
Member

@chasefleming chasefleming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Only nit is mixed use of title case on headers. Great work!

@jribbink jribbink merged commit 606ca7a into master Oct 18, 2024
5 checks passed
@jribbink jribbink deleted the jribbink/readme branch October 18, 2024 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Technical work without new features, refactoring, improving tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create README.md file for flow init
4 participants