Comments (13)
@tisonkun @kennytm @BusyJay @andylokandy @rleungx PTAL~
from community.
What if the author has written the issue number in the commit message already?
from community.
What if the author has written the issue number in the commit message already?
@BusyJay I think it's OK, because in the previous proposal, we also suggested that PR authors should associate issues in the PR body, the vast majority of PR meet the requirement of the new scheme and the old scheme at the same time.
- A pull request SHOULD be with a description mention the issue(s) associated, so that reviewers are able to get the information directly.
But I found that our PR template has changed, which causes subsequent new PRs that cannot meet the format requirements in the new schema.
I suggest that we first add the prefix Issue Number:
to the PR template again, which can make the template clearer and make text matching easily by the robot. After a period of transition, we can require the format of the issue number to be correct.
from community.
...I think it's OK...
What I mean is if author has written the issue number in commit message already, will the bot append the issue number again to the squashed commit message?
from community.
...I think it's OK...
What I mean is if author has written the issue number in commit message already, will the bot append the issue number again to the squashed commit message?
I think yes. The new method won't check any commit message and just append the issue number in the PR body to the final squashed commit message. We put the restriction that a PR must have a relevant issue from commit message to PR body.
from community.
Got it. It's a nice to have to skip appending if the issue is mentioned in the commit message. The overall idea lgtm.
from community.
will the bot append the issue number again to the squashed commit message?
The bot currently only extracts the issue number from the specified line of the PR body to the squashed commit message, but for the entire message of squashed commit, this depends on how we handle the message of commits in the PR.
- If we need to list each commit according to the requirements of DCO, the entire message of squashed commit will be:
the title of pull request
close #{{issue_numer_in_the_pr_body}}
* the message title of commit 1 in the PR
Signed-off-by: xxx <[email protected]>
* the message title of commit 2 in the PR
close #{{issue_numer_in_the_commit_message}}
Signed-off-by: xxx <[email protected]>
Both issue numbers in the PR body and commits will be appended to the squashed commit message.
- If we don't need to list each commit, the entire message of the squashed commit will be:
the title of the pull request
close #{{issue_numer_in_the_pr_body}}
Signed-off-by: xxx <[email protected]>
If DCO does not have such a strict requirement, I am willing to implement the second way through the bot, but I am not clear about the requirement of DCO.
from community.
If DCO does not have such a strict requirement, I am willing to implement the second way through the bot, but I am not clear about the requirement of DCO.
I asked experts who knew this better, it seems that CNCF does not require the commit message after the merging. And I found the other CNCF project (fox example: envoyproxy/envoy) can only remain one line Signed-off-by
, so I'll start implementing the second format.
from community.
I suggest to keep the commit messages or the PR body (only the content from "What's Change").
On the other hand, signoff lines should match all author fields.
from community.
If DCO does not have such a strict requirement, I am willing to implement the second way through the bot, but I am not clear about the requirement of DCO.
I asked experts who knew this better, it seems that CNCF does not require the commit message after the merging. And I found the other CNCF project (fox example: envoyproxy/envoy) can only remain one line
Signed-off-by
, so I'll start implementing the second format.
It's great that we can format commit message body whatever the way we like. As the formatting logic is becoming more powerful, we can really make it informative yet not too verbose.
from community.
I suggest to keep the commit messages or the PR body (only the content from "What's Change").
If we retain the commit message in the PR, the problem with squash commit message redundancy is not resolved.
I think it would be a better idea for the bot to extract the content from "What's Change" part of the PR body.
Maybe we can define a code block like release-note
to tell the bot to extract this part to the squashed commit message, for example:
### What is changed and how it works?
Issue Number: close #xxx
What's Changed:
```commit-message
Describe what PR has changed, and the content in the code block will be extracted into the squared commit message
```
from community.
I and @Mini256 propose a new rule for the commit message: #162
from community.
closed by ti-community-infra/configs#505
from community.
Related Issues (20)
- Proposal: Reduce the Entropy of TiKV Community Governance HOT 70
- Associate every repository with one and one and only one team HOT 1
- Update authentication mechanism HOT 8
- Update community governance description
- Write down the description of roles in TiKV community and how a member goes to that role HOT 1
- Clean up previous community stuff that invalid now
- Tracking issue for applying pr issue association HOT 2
- Create a proposal for pr issue association
- style: enforce order in team member json HOT 1
- new PR requirement and commit message style
- Transfer TiKV Dev Guide Repo to tikv org HOT 7
- Transfer rocksdb-rs Repo to tikv org HOT 11
- Maintainess issue of pprof-rs HOT 1
- Transfer `components/match_template` to tikv org HOT 11
- Transfer tidb_xxxx components to pingcap org HOT 2
- Update governance document HOT 1
- Nominate Qi Liu as TOC Member HOT 1
- Nominate Dongxu Huang as TOC Member HOT 1
- Transfer tikv/minitrace as fastracelabs/fastrace HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from community.