Skip to content

Readme Update #15394

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

Merged
merged 3 commits into from
May 19, 2025
Merged

Readme Update #15394

merged 3 commits into from
May 19, 2025

Conversation

Akshat1sharma321
Copy link
Contributor

📝 What is the purpose of the change?

This pull request improves the readability and structure of the README.md for the Apache Dubbo project. It includes:

  • A friendlier, GitHub Pages-compatible version table for Dubbo versions.
  • Rewritten sections with clearer, more concise descriptions.
  • Better formatting for contributors, users, and developers to quickly understand usage, contribution, and support options.
  • Preservation of all existing links, badges, and important references.

These changes aim to enhance the first-time user and contributor experience when landing on the GitHub repository.


✅ Checklist

  • Make sure there is a GitHub issue:
    While this is a documentation improvement and may not have a formal issue, it aligns with the ongoing efforts to improve contributor experience and documentation.

  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why:
    ✔️ The description above explains the enhancements made to the README, their purpose, and the intended benefit for users and contributors.

  • Write necessary unit-test to verify your logic correction:
    ❌ Not applicable — this is a documentation-only change. No source code or logic was modified.

  • Make sure GitHub Actions can pass:
    ✔️ GitHub workflows pass as this change does not affect the codebase or tests.

@codecov-commenter
Copy link

codecov-commenter commented May 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.86%. Comparing base (621323e) to head (c9c53f8).
Report is 69 commits behind head on 3.3.

Additional details and impacted files
@@             Coverage Diff              @@
##                3.3   #15394      +/-   ##
============================================
- Coverage     60.73%   58.86%   -1.88%     
+ Complexity    10929       12   -10917     
============================================
  Files          1887     1887              
  Lines         86219    86219              
  Branches      12923    12923              
============================================
- Hits          52368    50749    -1619     
- Misses        28380    29929    +1549     
- Partials       5471     5541      +70     
Flag Coverage Δ
integration-tests ?
samples-tests ?
unit-tests 58.86% <ø> (-0.03%) ⬇️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlbumenJ AlbumenJ merged commit 379fa90 into apache:3.3 May 19, 2025
18 of 19 checks passed
@Akshat1sharma321
Copy link
Contributor Author

Thanks a lot for recognising my work looking forward to contribute more .

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