docs: fix CONTRIBUTING/LICENSE links and mailto in README - #1997
Merged
GuangmingLuo merged 1 commit intoAug 31, 2026
Merged
Conversation
- README.md: point CONTRIBUTING and LICENSE links to the main branch (the default branch) instead of develop. - README.md: the community email link used a relative path that did not resolve; switch to a proper mailto: link. - CONTRIBUTING.md: fix a small grammar issue (Then can placed in -> They can be placed in).
|
|
GuangmingLuo
approved these changes
Aug 31, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1997 +/- ##
==========================================
+ Coverage 62.95% 63.10% +0.14%
==========================================
Files 394 396 +2
Lines 30267 30369 +102
==========================================
+ Hits 19056 19163 +107
+ Misses 9924 9923 -1
+ Partials 1287 1283 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
junliurs
approved these changes
Aug 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Fix three small documentation issues in
README.mdandCONTRIBUTING.md:README.md: the Contributing, License, and licenses links pointed to thedevelopbranch, which is no longer the default branch. Point them tomainso they no longer 404 for new readers.README.md: the community email used a relative-path Markdown link that did not resolve to a working address. Switch it to a propermailto:link.CONTRIBUTING.md: fix a small grammar issue in the "Reporting New Issues" section ("Then can placed in"->"They can be placed in").Why
These were noticed while reading the contributing flow. Wrong default-branch links and a broken mailto are friction for first-time contributors; the grammar fix is a drive-by while we are in the file.
How I checked
git diffagainstcloudwego/kitex:mainshows the three changes above, no other files touched.Notes
CONTRIBUTING.md§"Submit a Pull Request", the small scope of this PR should not require an issue, but happy to open one if maintainers prefer.