From e9a9304ee7814d94d301938e6247fc2586453534 Mon Sep 17 00:00:00 2001 From: Ian Smith Botsford Date: Fri, 23 Sep 2022 20:20:36 +0000 Subject: [PATCH 1/3] chore: update/clarify changelog instructions in CONTRIBUTING.md --- .../3c9cedab-7cd3-479c-b887-0cbdceeb9341.json | 5 +++++ CONTRIBUTING.md | 16 ++++++++-------- 2 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 .changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json diff --git a/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json b/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json new file mode 100644 index 00000000..e75ecc4a --- /dev/null +++ b/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json @@ -0,0 +1,5 @@ +{ + "id": "3c9cedab-7cd3-479c-b887-0cbdceeb9341", + "type": "misc", + "description": "Update/clarify changelog instructions in the Contributing Guidelines" +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1894b29..cede799a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,13 +46,13 @@ Merges to this repository must include one or more changelog entries which descr Entries are placed in the top-level `.changes/` directory. An entry is a file containing a JSON object with the following fields: -| Field name | Type | Required | Enum | Description | -|---------------|------------|----------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | `string` | yes | | A unique identifier for this entry. We recommend you generate a UUID for this field. | -| `type` | `string` | yes | `bugfix`, `feature`, `documentation`, `misc` | The type of change being made. | -| `description` | `string` | yes | | A description of the change being made. | +| Field name | Type | Required | Enum | Description | +|---------------|------------|----------|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | `string` | yes | | A unique identifier for this entry. We recommend you generate a UUID for this field. | +| `type` | `string` | yes | `bugfix`, `feature`, `documentation`, `misc` | The type of change being made. | +| `description` | `string` | yes | | A description of the change being made. | | `issues` | `string[]` | no | | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways: | -| `module` | `string` | no | | The area of the code affected by your changes. If unsure, leave this value unset. | +| `module` | `string` | no | | The area of the code affected by your changes. If unsure, leave this value unset. | The filename of an entry is arbitrary. We recommend `.json`, where `` corresponds to the `id` field of the entry itself. @@ -68,7 +68,7 @@ of your request may disagree and ask that you add one anyway. { "id": "263ea6ab-4b75-41a8-9c37-821c30d7b9e5", "type": "feature", - "description": "Add binding for CRT URL parsing.", + "description": "Add binding for CRT URL parsing", "issues": [ "awslabs/aws-crt-kotlin#12345" ] @@ -88,7 +88,7 @@ opensource-codeofconduct@amazon.com with any additional questions or comments. ## Security issue notifications -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## Licensing From 11a890bbc458c8785b27492dd4cf4df8133bca93 Mon Sep 17 00:00:00 2001 From: Ian Smith Botsford Date: Fri, 23 Sep 2022 20:31:38 +0000 Subject: [PATCH 2/3] add commit guidelines --- .../3c9cedab-7cd3-479c-b887-0cbdceeb9341.json | 2 +- CONTRIBUTING.md | 54 +++++++++++++++++++ 2 files changed, 55 insertions(+), 1 deletion(-) diff --git a/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json b/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json index e75ecc4a..19d8e778 100644 --- a/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json +++ b/.changes/3c9cedab-7cd3-479c-b887-0cbdceeb9341.json @@ -1,5 +1,5 @@ { "id": "3c9cedab-7cd3-479c-b887-0cbdceeb9341", "type": "misc", - "description": "Update/clarify changelog instructions in the Contributing Guidelines" + "description": "Update/clarify changelog and add commit instructions in the Contributing Guidelines" } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cede799a..1fd0a379 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,61 @@ of your request may disagree and ask that you add one anyway. } ``` +### Git Commit Guidelines +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. +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**: + +``` +(): + + + +