Skip to content

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

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 1 commit into from
Nov 13, 2023

Conversation

Leoyoungxh
Copy link
Contributor

@Leoyoungxh Leoyoungxh commented Nov 9, 2023

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
Copy link
Contributor Author

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

Copy link

codecov bot commented Nov 9, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@                 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 Coverage Δ
unittests 85.71606% <ø> (+0.22329%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 7 files with indirect coverage changes

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

@liuzengh
Copy link
Contributor

liuzengh commented Nov 9, 2023

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
Copy link
Contributor Author

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.

Copy link
Contributor

@liuzengh liuzengh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@sandyskies sandyskies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

- type/documentation: 添加文档。
- type/api-change: 添加、删除或更改 API。
- type/failing-test: CI 测试用例偶发失败。
- type/performance: 改进性能的变更。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should add improvement

@sandyskies sandyskies merged commit cc272f5 into trpc-group:main Nov 13, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Nov 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants