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

Improve description in readme and extract internals #192

Merged
merged 8 commits into from
Jan 28, 2024
Merged

Improve description in readme and extract internals #192

merged 8 commits into from
Jan 28, 2024

Conversation

vjik
Copy link
Member

@vjik vjik commented Jan 27, 2024

Q A
Is bugfix?
New feature?
Breaks BC?

Copy link

codecov bot commented Jan 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5a66792) 96.86% compared to head (045fc37) 96.86%.

❗ Current head 045fc37 differs from pull request most recent head 67e536f. Consider uploading reports for the commit 67e536f to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #192   +/-   ##
=========================================
  Coverage     96.86%   96.86%           
  Complexity       79       79           
=========================================
  Files             9        9           
  Lines           255      255           
=========================================
  Hits            247      247           
  Misses            8        8           

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

@vjik vjik added the type:docs Documentation label Jan 27, 2024
Copy link

what-the-diff bot commented Jan 27, 2024

PR Summary

  • Updated README.md File
    The main project document was updated to reflect recent changes and provide better information on Yii Console package. This includes an improved description, list of new features, updated installation command, and a link to a deeper section on how Yii Console works.

  • Updated composer.json File
    Composer, our dependency management tool, had its core file modified to better describe the Yii Console package.

  • Addition of internals.md in Docs
    A new document was added that deep dives into the technical underpinnings of our package. This offers insight into unit testing, examining code mutations, static code analysis, style guide preferences, dependencies, and how the Composer Requirement Checker operates.

@vjik vjik requested a review from a team January 27, 2024 15:45
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
vjik and others added 6 commits January 28, 2024 14:03
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
@vjik vjik merged commit a686693 into master Jan 28, 2024
14 of 17 checks passed
@vjik vjik deleted the improve branch January 28, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants