Skip to content

Commit 42f04b1

Browse files
authored
PR guidelines (#1986)
1 parent ee8789f commit 42f04b1

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ For more explained information about plugin override check [Development Override
6767

6868
#### PR Title Format
6969

70-
A third person point of view is used when describing the changes made. Additionally, we use [*Conventional Commits*](https://www.conventionalcommits.org/) enforcing the subject of the title to start with a uppercase character:
70+
Use [*Conventional Commits*](https://www.conventionalcommits.org/) to name pull requests, starting with the type of change followed by a description of the change. Use a third person point of view, [active voice](https://www.mongodb.com/docs/meta/style-guide/writing/use-active-voice/#std-label-use-active-voice), and start each description with an uppercase character:
71+
7172
- `fix: Description of the PR`: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
7273
- `chore: Description of the PR`: the commit includes a technical or preventative maintenance task that is necessary for managing the product or the repository, but it is not tied to any specific feature or user story (this correlates with PATCH in Semantic Versioning).
7374
- `doc: Description of the PR`: The commit adds, updates, or revises documentation that is stored in the repository (this correlates with PATCH in Semantic Versioning).
@@ -86,6 +87,16 @@ Examples:
8687
- If the PR has `BREAKING CHANGE`: in its description is a breaking change
8788
- `remove!: Description of the PR`: The commit removes a feature from the product. Typically features are deprecated first for a period of time before being removed. Removing a feature is a breaking change (correlating with MAJOR in Semantic Versioning).
8889

90+
Example PR title:
91+
```bash
92+
chore: Upgrades `privatelink_endpoint_service_data_federation_online_archive` resource to auto-generated SDK
93+
```
94+
95+
- The example PR title starts with a task type, "chore:"
96+
- The description begins with an uppercase character, "U" in "Upgrades"
97+
- The description uses active voice with the verb "Upgrades," where the subject is
98+
implicitly the PR itself.
99+
89100
### Testing the Provider
90101

91102
In order to test the provider, you can run `make test`. You can use [meta-arguments](https://www.terraform.io/docs/configuration/providers.html) such as `alias` and `version`. The following arguments are supported in the MongoDB Atlas `provider` block:

0 commit comments

Comments
 (0)