You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`id`|`string`| yes || A unique identifier for this entry. We recommend you generate a UUID for this field. |
68
68
|`type`|`string`| yes |`bugfix`, `feature`, `documentation`, `misc`| The type of change being made. |
69
-
|`description`|`string`| yes || A description of the change being made.|
69
+
|`description`|`string`| yes || A description of the change being made.<ul><li>Prefix with `**Breaking**:` if the change is breaking</li><li>Use the imperative present tense (e.g., "change" not "changed" nor "changes")</li><li>Capitalize first letter</li><li>No dot (.) at the end unless there are multiple sentences</li></ul>|
70
70
|`issues`|`string[]`| no || A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:<ul><li>The issue number, if local to this repository (eg. `#12345`)</li><li>A fully-qualified issue ID (eg.`awslabs/smithy-kotlin#12345`)</li><li>A fully-qualified URL (eg. `https://issuetracker.com/12345`)</li></ul> |
71
71
|`module`|`string`| no || The area of the code affected by your changes. If unsure, leave this value unset. |
72
72
@@ -84,13 +84,69 @@ of your request may disagree and ask that you add one anyway.
84
84
{
85
85
"id": "263ea6ab-4b75-41a8-9c37-821c30d7b9e5",
86
86
"type": "feature",
87
-
"description": "Add multiplatform support for URL parsing.",
87
+
"description": "Add multiplatform support for URL parsing",
88
88
"issues": [
89
89
"awslabs/aws-sdk-kotlin#12345"
90
90
]
91
91
}
92
92
```
93
93
94
+
### Git Commit Guidelines
95
+
This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for its commit message format and expects all contributors to follow these guidelines.
96
+
97
+
Each commit message consists of a **header**, a **body** (optional), and a **footer** (optional). The header has a special format that includes a **type**, a **scope** and a **subject**:
98
+
99
+
```
100
+
<type>(<scope>): <subject>
101
+
<BLANK LINE>
102
+
<body>
103
+
<BLANK LINE>
104
+
<footer>
105
+
```
106
+
107
+
Any line of the commit message should not be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
108
+
109
+
#### Type
110
+
111
+
Must be one of the following:
112
+
113
+
-**feat**: A new feature
114
+
-**fix**: A bug fix
115
+
-**docs**: Documentation only changes
116
+
-**style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
117
+
-**refactor**: A code change that neither fixes a bug or adds a feature
118
+
-**perf**: A code change that improves performance
119
+
-**test**: Adding missing tests
120
+
-**chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
121
+
-**ci**: Changes to CI/CD scripts and tooling
122
+
123
+
#### Scope
124
+
125
+
The scope is optional but should be included when possible and refer to a module that is being touched. Examples:
126
+
127
+
- codegen
128
+
- rt (optionally the target platform e.g. rt-android)
129
+
130
+
#### Subject
131
+
132
+
The subject contains succinct description of the change:
133
+
134
+
- Use the imperative present tense (e.g., "change" not "changed" nor "changes")
135
+
- Don't capitalize first letter
136
+
- No dot (.) at the end
137
+
138
+
#### Body (optional)
139
+
140
+
Just as in the **subject**, 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.
141
+
142
+
#### Footer (optional)
143
+
144
+
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
145
+
146
+
The last line of commits introducing breaking changes should be in the form `BREAKING CHANGE: <desc>`
147
+
148
+
Breaking changes should also add an exclamation mark `!` after the type/scope (e.g. `refactor(rt)!: drop support for Android API < 20`)
149
+
94
150
### Automated PR checks
95
151
96
152
A number of automated workflows run when a PR is submitted. Generally speaking, each of these must pass before the PR is
0 commit comments