From 651c0f17d9371879ab481b51a4972986c992b1e7 Mon Sep 17 00:00:00 2001 From: Guillaume Verdier Date: Fri, 24 Apr 2026 15:05:46 +0000 Subject: [PATCH 1/4] chore: improve pull request template with breaking change and title requirements --- .github/pull_request_template.md | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 675baaf..50c7800 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,6 +17,24 @@ _Please select one or more categories that apply to this change._ - [ ] **UCP Schema**: Changes to the `ucp-schema` tool (resolver, linter, validator). (Requires Maintainer approval) - [ ] **Community Health (.github)**: Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval) +--- + +### Is this a Breaking Change or Removal? + +Does this introduce a breaking change to the schema or protocol, or remove any existing fields/files? +If yes: +- [ ] **I have added `!` to my PR title** (e.g., `feat!: remove field`). +- [ ] **I have provided a detailed justification below:** + +```text +## Breaking Changes / Removal Justification + +(Please provide a detailed technical and strategic rationale here for why this +breaking change or removal is necessary.) +``` + +--- + ## Related Issues @@ -26,9 +44,28 @@ _Please select one or more categories that apply to this change._ - [ ] I have followed the [Contributing Guide](https://github.com/Universal-Commerce-Protocol/.github/blob/main/CONTRIBUTING.md). - [ ] I have updated the documentation (if applicable). - [ ] My changes pass all local linting and formatting checks. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] New and existing unit tests pass locally with my changes. - [ ] (For Core/Capability) I have included/updated the relevant JSON schemas. - [ ] I have regenerated Python Pydantic models by running generate_models.sh under python_sdk. ## Screenshots / Logs (if applicable) + +--- + +### Pull Request Title Requirements + +This organization enforces **Conventional Commits**. Your PR title must follow this format: `type: description` or `type!: description` for breaking changes. + +**Common Types:** +- `feat`: A new feature +- `fix`: A bug fix +- `docs`: Documentation only changes +- `chore`: Changes to the build process or auxiliary tools and libraries +- `refactor`: A code change that neither fixes a bug nor adds a feature + +**Breaking Changes:** +If your change is a breaking change (e.g., removing a field or file), you **must** add `!` before the colon in your title: +`type!: description` (Example: `feat!: remove deprecated buyer field from checkout`) From 6b990f96b87e090bdd91051bbadcb1562f7210c6 Mon Sep 17 00:00:00 2001 From: Guillaume Verdier Date: Fri, 24 Apr 2026 15:20:50 +0000 Subject: [PATCH 2/4] chore: consolidate breaking change section into title requirements --- .github/pull_request_template.md | 41 ++++++++++---------------------- 1 file changed, 13 insertions(+), 28 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 50c7800..b6277ac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,24 +17,6 @@ _Please select one or more categories that apply to this change._ - [ ] **UCP Schema**: Changes to the `ucp-schema` tool (resolver, linter, validator). (Requires Maintainer approval) - [ ] **Community Health (.github)**: Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval) ---- - -### Is this a Breaking Change or Removal? - -Does this introduce a breaking change to the schema or protocol, or remove any existing fields/files? -If yes: -- [ ] **I have added `!` to my PR title** (e.g., `feat!: remove field`). -- [ ] **I have provided a detailed justification below:** - -```text -## Breaking Changes / Removal Justification - -(Please provide a detailed technical and strategic rationale here for why this -breaking change or removal is necessary.) -``` - ---- - ## Related Issues @@ -55,17 +37,20 @@ breaking change or removal is necessary.) --- -### Pull Request Title Requirements +### Pull Request Title & Breaking Changes -This organization enforces **Conventional Commits**. Your PR title must follow this format: `type: description` or `type!: description` for breaking changes. +This organization enforces **Conventional Commits** (`type: description`). -**Common Types:** -- `feat`: A new feature -- `fix`: A bug fix -- `docs`: Documentation only changes -- `chore`: Changes to the build process or auxiliary tools and libraries -- `refactor`: A code change that neither fixes a bug nor adds a feature +**Common Types:** `feat`, `fix`, `docs`, `chore`, `refactor`. **Breaking Changes:** -If your change is a breaking change (e.g., removing a field or file), you **must** add `!` before the colon in your title: -`type!: description` (Example: `feat!: remove deprecated buyer field from checkout`) +If this PR introduces a breaking change or removes existing fields/files: +- [ ] **I have added `!` to my PR title** (e.g., `feat!: remove field`). +- [ ] **I have provided a justification below.** + +```text +## Breaking Changes / Removal Justification + +(Please provide a detailed technical and strategic rationale here for why this +breaking change or removal is necessary.) +``` From 41584630b7aa0bd7051aa62d45167a1929171109 Mon Sep 17 00:00:00 2001 From: Guillaume Verdier Date: Fri, 24 Apr 2026 15:47:08 +0000 Subject: [PATCH 3/4] chore: lean PR template by merging title requirements into contributing guide bullet --- .github/pull_request_template.md | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b6277ac..37cd31a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -23,7 +23,7 @@ _Please select one or more categories that apply to this change._ ## Checklist -- [ ] I have followed the [Contributing Guide](https://github.com/Universal-Commerce-Protocol/.github/blob/main/CONTRIBUTING.md). +- [ ] I have followed the [Contributing Guide](https://github.com/Universal-Commerce-Protocol/.github/blob/main/CONTRIBUTING.md) (including Conventional Commits title requirements and `!` for breaking changes). - [ ] I have updated the documentation (if applicable). - [ ] My changes pass all local linting and formatting checks. - [ ] I have added tests that prove my fix is effective or that my feature works. @@ -34,23 +34,3 @@ _Please select one or more categories that apply to this change._ ## Screenshots / Logs (if applicable) - ---- - -### Pull Request Title & Breaking Changes - -This organization enforces **Conventional Commits** (`type: description`). - -**Common Types:** `feat`, `fix`, `docs`, `chore`, `refactor`. - -**Breaking Changes:** -If this PR introduces a breaking change or removes existing fields/files: -- [ ] **I have added `!` to my PR title** (e.g., `feat!: remove field`). -- [ ] **I have provided a justification below.** - -```text -## Breaking Changes / Removal Justification - -(Please provide a detailed technical and strategic rationale here for why this -breaking change or removal is necessary.) -``` From 54fb8f2f7bb57a495130d83b73f6d3f71336a2cc Mon Sep 17 00:00:00 2001 From: Guillaume Verdier Date: Fri, 24 Apr 2026 15:50:55 +0000 Subject: [PATCH 4/4] docs: update PR template with screenshot guidance for UCP.dev and fixes --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 37cd31a..e464cac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -33,4 +33,4 @@ _Please select one or more categories that apply to this change._ ## Screenshots / Logs (if applicable) - +