Skip to content

Commit 7eacb05

Browse files
authored
docs(contributing): added PR title format (#14534)
1 parent 88064ba commit 7eacb05

File tree

2 files changed

+15
-49
lines changed

2 files changed

+15
-49
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for contributing to DataHub!
44
55
Before you submit your PR, please go through the checklist below:
66
7-
- [ ] The PR conforms to DataHub's [Contributing Guideline](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md) (particularly [Commit Message Format](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md#commit-message-format))
7+
- [ ] The PR conforms to DataHub's [Contributing Guideline](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md) (particularly [PR Title Format](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md#pr-title-format))
88
- [ ] Links to related issues (if applicable)
99
- [ ] Tests for the changes have been added/updated (if applicable)
1010
- [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.

docs/CONTRIBUTING.md

Lines changed: 14 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ We always welcome contributions to help make DataHub better. Take a moment to re
66

77
Have ideas about how to make DataHub better? Head over to [DataHub Feature Requests](https://feature-requests.datahubproject.io/) and tell us all about it!
88

9-
Show your support for other requests by upvoting; stay up to date on progess by subscribing for updates via email.
9+
Show your support for other requests by upvoting; stay up to date on progress by subscribing for updates via email.
1010

1111
## Reporting Issues
1212

13-
We use GitHub issues to track bug reports and submitting pull requests.
13+
We use GitHub issues to track bug reports and submit pull requests.
1414

1515
If you find a bug:
1616

@@ -22,34 +22,34 @@ If you find a bug:
2222

2323
## Submitting a Request For Comment (RFC)
2424

25-
If you have a substantial feature or a design discussion that you'd like to have with the community follow the RFC process outlined [here](./rfc.md)
25+
If you have a substantial feature or a design discussion that you'd like to have with the community, follow the RFC process outlined [here](./rfc.md).
2626

2727
## Submitting a Pull Request (PR)
2828

2929
Before you submit your Pull Request (PR), consider the following guidelines:
3030

3131
- Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
32-
- Follow the [standard GitHub approach](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to create the PR. Please also follow our [commit message format](#commit-message-format).
33-
- If there are any breaking changes, potential downtime, deprecations, or big feature please add an update in [Updating DataHub under Next](how/updating-datahub.md).
32+
- Open a pull request (PR) following [GitHub’s standard workflow](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
33+
- Please make sure to follow our [PR Title Format](#pr-title-format) for clarity and consistency.
34+
- PRs are squashed and merged, resulting in a single commit with the PR title as the commit message.
35+
- If there are any breaking changes, potential downtime, deprecations, or big features, please add an update in [Updating DataHub under Next](how/updating-datahub.md).
3436
- That's it! Thank you for your contribution!
3537

36-
## Commit Message Format
37-
38-
Please follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for the commit message format. In summary, each commit message consists of a _header_, a _body_ and a _footer_, separated by a single blank line.
38+
### PR Title Format
3939

4040
```
4141
<type>[optional scope]: <description>
42+
```
4243

43-
[optional body]
44+
Example:
4445

45-
[optional footer(s)]
46+
```
47+
feat(parser): add ability to parse arrays
4648
```
4749

48-
Any line of the commit message cannot be longer than 88 characters! This allows the message to be easier to read on GitHub as well as in various Git tools.
49-
50-
### Type
50+
#### Type
5151

52-
Must be one of the following (based on the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)):
52+
Must be one of the following:
5353

5454
- _feat_: A new feature
5555
- _fix_: A bug fix
@@ -60,37 +60,3 @@ Must be one of the following (based on the [Angular convention](https://github.c
6060
- _style_: Changes that do not affect the meaning of the code (whitespace, formatting, missing semicolons, etc.)
6161
- _build_: Changes that affect the build system or external dependencies
6262
- _ci_: Changes to our CI configuration files and scripts
63-
64-
A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g.,
65-
66-
```
67-
feat(parser): add ability to parse arrays
68-
```
69-
70-
### Description
71-
72-
Each commit must contain a succinct description of the change:
73-
74-
- use the imperative, present tense: "change" not "changed" nor "changes"
75-
- don't capitalize the first letter
76-
- no dot(.) at the end
77-
78-
### Body
79-
80-
Just as in the description, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
81-
82-
### Footer
83-
84-
The footer should contain any information about _Breaking Changes_, and is also the place to reference GitHub issues that this commit _Closes_.
85-
86-
_Breaking Changes_ should start with the words `BREAKING CHANGE:` with a space or two new lines. The rest of the commit message is then used for this.
87-
88-
### Revert
89-
90-
If the commit reverts a previous commit, it should begin with `revert:`, followed by the description. In the body it should say: `Refs: <hash1> <hash2> ...`, where the hashs are the SHA of the commits being reverted, e.g.
91-
92-
```
93-
revert: let us never again speak of the noodle incident
94-
95-
Refs: 676104e, a215868
96-
```

0 commit comments

Comments
 (0)