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

Extract "testing" section from readme + Add section "development environment" #61

Merged
merged 3 commits into from
Feb 17, 2024

Conversation

vjik
Copy link
Member

@vjik vjik commented Feb 17, 2024

Q A
Is bugfix?
New feature?
Breaks BC?
Fixed issues comma-separated list of tickets # fixed by the PR, if any

@vjik vjik added status:code review The pull request needs review. type:docs Documentation labels Feb 17, 2024
@vjik vjik requested a review from a team February 17, 2024 08:36
Copy link

what-the-diff bot commented Feb 17, 2024

PR Summary

  • Introduction of Internal Documentation
    A new file called docs/internals.md has been added. This document will help to understand more about the project's inner workings. It covers various aspects such as setting up the development environment, conducting unit and mutation testing, using static analysis, following the code style, and managing dependencies.

  • Simplified Installation Instruction
    The command needed to incorporate the yiisoft/cache-memcached package has now been simplified in the README.md. The --prefer-dist flag has been removed to make the command more straightforward.

  • Enhanced Support Information
    The "Support the project" section in README.md has been updated with added links to Open Collective for sponsorship, making it easier for those who wish to financially support the project.

  • Extended Follow-Up Options
    People interested in following updates on the project now have a broader range of platforms to choose from. Links to the project's official website, Twitter, Telegram, Facebook, and Slack have been added to the "Follow Updates" section of README.md.

  • Updated License Information
    The "License" section has been removed from README.md for simplification. However, it's been specified that the project is released under the BSD License, and a direct link to the LICENSE.md file is provided.

  • Clarification on Project Maintenance
    The README file has been updated to clearly mark Yii Software as the maintainer of the project in the "Maintained by" section.

@vjik vjik merged commit f980f12 into master Feb 17, 2024
10 of 11 checks passed
@vjik vjik deleted the docs branch February 17, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:code review The pull request needs review. type:docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants