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
- Add a CODEOWNERS file.
- Amend conventional commits CI validation for shorter
line lengths on subject and remove type(scope): subject
the scope requirement.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+58Lines changed: 58 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -215,6 +215,64 @@ To send us a pull request, please:
215
215
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
216
216
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
217
217
218
+
### Pull Request Title and Commit Message Format
219
+
220
+
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for PR titles and commit messages. This helps us maintain a clear project history and enables automated tooling.
221
+
222
+
**Format:**`type: subject`
223
+
224
+
-**type**: The type of change (required)
225
+
-**subject**: Brief description of the change (required, max 50 characters)
226
+
227
+
**Valid types:**
228
+
-`feat`: New features
229
+
-`fix`: Bug fixes
230
+
-`docs`: Documentation changes
231
+
-`test`: Adding or updating tests
232
+
-`refactor`: Code refactoring without functional changes
233
+
-`perf`: Performance improvements
234
+
-`style`: Code style/formatting changes
235
+
-`chore`: Maintenance tasks
236
+
-`ci`: CI/CD changes
237
+
-`build`: Build system changes
238
+
-`deps`: Dependency updates
239
+
240
+
**Examples:**
241
+
```
242
+
feat: add retry mechanism for operations
243
+
fix: resolve memory leak in execution state
244
+
docs: update API documentation for context
245
+
test: add integration tests for parallel exec
246
+
feat(sdk): implement new callback functionality
247
+
fix(examples): correct timeout handling
248
+
```
249
+
250
+
**Requirements:**
251
+
- Subject line must be 50 characters or less
252
+
- Body text should wrap at 72 characters for good terminal display
253
+
- Use lowercase for type and scope
254
+
- Use imperative mood in subject ("add" not "added" or "adds")
255
+
- No period at the end of the subject line
256
+
- Use conventional commit message format with clear, concise descriptions
257
+
- Body should provide detailed explanation of changes with bullet points when helpful
258
+
259
+
**Full commit message example:**
260
+
```
261
+
feat: add retry mechanism for operations
262
+
263
+
- Implement exponential backoff strategy for transient failures
264
+
- Add configurable retry limits and timeout settings
265
+
- Include comprehensive error logging for debugging
266
+
- Update documentation with retry configuration examples
267
+
268
+
Resolves issue with intermittent network failures causing
269
+
execution interruptions in production environments.
270
+
```
271
+
272
+
The PR title will be used as the commit message when your PR is merged, so please ensure it follows this format.
273
+
274
+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
275
+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
218
276
219
277
## Finding contributions to work on
220
278
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
0 commit comments