Skip to content

[doc]Created commit-format-specification.md#7190

Merged
morningman merged 3 commits intoapache:masterfrom
luzhijing:docs
Nov 24, 2021
Merged

[doc]Created commit-format-specification.md#7190
morningman merged 3 commits intoapache:masterfrom
luzhijing:docs

Conversation

@luzhijing
Copy link
Contributor

Proposed changes

We found that many commit messages submitted at present have ambiguous information. Clear commit messages can help developers submit pull requests more readable, committers merge easilerly and Release Manager easy to release. Therefore, we have sorted out a version of the commit format specification. We hope that subsequent contributors can sort out the commit messages according to the specification when submitting Pull Request.

我们发现当前提交的很多Commit Message存在信息模糊的情况,清晰的Commit Message可以帮助开发者提交的Pull Request更加易读,便于Committer合入,也便于Release Manager进行发版。因此我们整理了一版Commit格式规范,希望后续Contributor在提交PR时可以按照规范整理Commit Message。

Types of changes

What types of changes does your code introduce to Doris?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)
  • Code refactor (Modify the code structure, format the code, etc...)
  • Optimization. Including functional usability improvements and performance improvements.
  • Dependency. Such as changes related to third-party components.
  • Other.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have created an issue on (Fix #ISSUE) and described the bug/feature there in detail
  • Compiling and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • If these changes need document changes, I have updated the document
  • Any dependent changes have been merged

Further comments

If this is a relatively large or complex change, kick off the discussion at dev@doris.apache.org by explaining why you chose the solution you did and what alternatives you considered, etc...

We found that many commit messages submitted at present have ambiguous information. Clear commit messages can help developers submit pull requests more readable, committers merge easilerly and Release Manager easy to release. Therefore, we have sorted out a version of the commit format specification. We hope that subsequent contributors can sort out the commit messages according to the specification when submitting Pull Request.
Copy link
Contributor

@morningman morningman left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions github-actions bot added the approved Indicates a PR has been approved by one committer. label Nov 23, 2021
@github-actions
Copy link
Contributor

PR approved by at least one committer and no changes requested.

@github-actions
Copy link
Contributor

PR approved by anyone and no changes requested.

@morningman morningman merged commit 4b45b80 into apache:master Nov 24, 2021
@luzhijing luzhijing deleted the docs branch December 7, 2021 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by one committer. reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants