search

trpc-group / trpc-go

A pluggable, high-performance RPC framework written in golang
Other
743 stars 85 forks source link

docs: add requirements for PR labels in contribution guide #134

Closed Leoyoungxh closed 7 months ago

Leoyoungxh commented 8 months ago

In order to generate the changlog quickly during the release process, PR guidelines needs to be further improved.

Improve the PR template and documentation, requiring the inclusion of release notes in the PR description and setting appropriate labels.

RELEASE NOTES: NONE

Leoyoungxh commented 8 months ago

In the future, mayby consider using the mergeable plugin to check if the PR description meets the requirements.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (37d2008) 85.49277% compared to head (7ab7cfb) 85.71606%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #134 +/- ## =================================================== + Coverage 85.49277% 85.71606% +0.22329% =================================================== Files 189 189 Lines 16123 16123 =================================================== + Hits 13784 13820 +36 + Misses 1778 1745 -33 + Partials 561 558 -3 ``` | [Flag](https://app.codecov.io/gh/trpc-group/trpc-go/pull/134/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trpc-group) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/trpc-group/trpc-go/pull/134/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trpc-group) | `85.71606% <ø> (+0.22329%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trpc-group#carryforward-flags-in-the-pull-request-comment) to find out more. [see 7 files with indirect coverage changes](https://app.codecov.io/gh/trpc-group/trpc-go/pull/134/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trpc-group)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

liuzengh commented 8 months ago

Perhaps we can create a release guideline document first, to understand the overall process of releasing, and then add the relevant information to the contributor guide

Leoyoungxh commented 8 months ago

Perhaps we can create a release guideline document first, to understand the overall process of releasing, and then add the relevant information to the contributor guide

Sounds good! But I think we can add the release guideline later. Compared to contributors, repository maintainers are more concerned about the release process.