From b7ccdc9ff5fa6b4d943624305743a4d962084cb7 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 11:53:50 -0700 Subject: [PATCH 01/12] sample pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 58 ++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..2a2314a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,58 @@ + + +## Description + + + + +## What type of PR is this? (only check one) + + +- [ ] Feature (`feat`) +- [ ] Bug Fix (`fix`) +- [ ] Refactor (`refactor`) +- [ ] Documentation Update (`doc`) +- [ ] Other, please specify: + +### Does this PR introduce any breaking changes? + +- [ ] No +- [ ] Yes, and this is why: +- [ ] I need help determining if there are any breaking changes + +### Does the PR title type prefix match the selected type? +- [ ] Yes +- [ ] No, and this is why: +- [ ] I need help select the right one + +## Added/updated tests? +_Please keep the code coverage percentage at 80% and above._ +- [ ] Yes +- [ ] No, and this is why: +- [ ] I need help with writing tests From 2b778ba482a84cf981bacf9b9b1e875f65d62dd7 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 11:54:05 -0700 Subject: [PATCH 02/12] pull request format guide --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 74 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 320d1ae..de61ab4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# changelogs -Changelogs for MyDecisive components +# Changelogs + +This repository contains guidelines, templates, configurations, etc for MDAI that will help us format everything properly so that our changelog generator will function as expected. In addition to that, this repository will also contain the changelog that outlines changes across different MDAI components that makes up an release. + +### Table of Contents +- [Guidelines](#guidelines) + - [Pull Request Format](#pull-request-format) + - [Pull Request Title](#pull-request-title) + - [Type](#type) + - [[Optional] Scope](#optional-scope) + - [Breaking Changes Indicator](#breaking-changes-indicator) + - [Subject](#subject) + - [Pull Request Description](#pull-request-description) + +# Guidelines + +## Pull Request Format + +Changes can only be `Squashed & Merged` to `main` of any repositories of MDAI via a pull request. The pull request must follow the format outlined in this section to both give reviewer an easier time to understand context of the pull request and also to ensure our changelog generator can parse the changes properly. + +### Pull Request Title + +Title of a pull request must follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format (without optional body and footer), meaning the title must following the following structure: + +
+<type>(<optional scope>): <subject>
+
+ +#### Type + +Must be one of the following: + +- `feat`: Add or change a feature +- `fix`: Fixes issue with the codebase + - `security`: A type of fixes that resolve security concerns + - `style`: A type of fixes address code style (e.g., white-space, formatting, missing semi-colons) and do not affect application behavior +- `doc`: Documentation only changes +- `refactor`: Rewrite or restructure code without altering behavior + - `perf`: A type of refactor that specifically improves performance +- `test`: Adding missing tests or correcting existing tests +- `revert`: Reverts a previous commit + - *Note: For revert type, `` must be the commit message of the commit its reverting.* +- `build`: Affect build-related components (e.g., build tools, dependencies, project version, CI/CD pipelines, etc) +- `chore`: Miscellaneous commits (e.g., modifying `.gitignore`) + +#### [Optional] Scope + +The scope is optional and provides additional contextual information. + +> [!IMPORTANT] +> Do NOT use issue identifiers as scopes. + +TODO: Additional instructions will be added once we figure out how we'll be combining changelogs across multiple repositories to form MDAI changelog. + +#### Breaking Changes Indicator + +A commit that introduce breaking changes must be indicated by an `!` before the `:` in the subject line (e.g. `feat(scope)!: remove deprecated`). + +#### Subject + +The subject contains a succinct description of the change: +- Use the imperative, present tense: "change" not "changed" nor "changes" +- Do not capitalize the first letter +- Do not end the description with a period (.) +- In case of breaking changes, see [Breaking Changes Indicator](#breaking-changes-indicator) + +### Pull Request Description + +Make sure you followed the instruction outlined in the `PULL_REQUEST_TEMPLATE.md` of the repository you are working in. + +If the repository you are working in does not have a pull request template yet, please copy [`PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) and paste it in the `.github` folder. + +> [!TIP] +> `PULL_REQUEST_TEMPLATE.md` find in this repository is only meant to be used as a baseline, it can and should be modified to fit the specific need of each repositories. From 5dcd2fc41c0ac3163ed32f84e42e85db6b105770 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 11:54:42 -0700 Subject: [PATCH 03/12] add code owners --- .github/CODEOWNERS | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..5d1d67e --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,5 @@ +# @DecisiveAI/reviewers will be the default owners for +# everything in the repo. Unless a later match takes +# precedence, reviewers team will be requested for review +# when someone opens a pull request. +* @DecisiveAI/reviewers From e90288246199ddcd265aa46e5282c174f554d510 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 12:03:58 -0700 Subject: [PATCH 04/12] add example --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index de61ab4..346fcc4 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ This repository contains guidelines, templates, configurations, etc for MDAI tha - [[Optional] Scope](#optional-scope) - [Breaking Changes Indicator](#breaking-changes-indicator) - [Subject](#subject) + - [Example](#examples) - [Pull Request Description](#pull-request-description) # Guidelines @@ -64,6 +65,18 @@ The subject contains a succinct description of the change: - Do not end the description with a period (.) - In case of breaking changes, see [Breaking Changes Indicator](#breaking-changes-indicator) +#### Examples + +``` +fix: fix container/service builder +``` +``` +feat(mdai-event-hub): add generic webhook action support +``` +``` +refactor!: added/updated labels for managed ConfigMaps +``` + ### Pull Request Description Make sure you followed the instruction outlined in the `PULL_REQUEST_TEMPLATE.md` of the repository you are working in. From c478eb71edc81eb11579388ef6e7ba8e5a474b7b Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 12:13:29 -0700 Subject: [PATCH 05/12] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 346fcc4..9f3797d 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ fix: fix container/service builder feat(mdai-event-hub): add generic webhook action support ``` ``` -refactor!: added/updated labels for managed ConfigMaps +refactor!: update labels for managed ConfigMaps ``` ### Pull Request Description From 1b74972c9c7a8dc553ce8f0dcaa1e610621c6ba7 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 12:15:00 -0700 Subject: [PATCH 06/12] more typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f3797d..0a328f2 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Must be one of the following: - `perf`: A type of refactor that specifically improves performance - `test`: Adding missing tests or correcting existing tests - `revert`: Reverts a previous commit - - *Note: For revert type, `` must be the commit message of the commit its reverting.* + - *Note: For revert type, `` must be the commit message of the commit its reverting.* - `build`: Affect build-related components (e.g., build tools, dependencies, project version, CI/CD pipelines, etc) - `chore`: Miscellaneous commits (e.g., modifying `.gitignore`) From ae62ca16fcab50a4d8a5c8f5e6956559a35dfe66 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 12:17:14 -0700 Subject: [PATCH 07/12] weird spacing --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2a2314a..9768f3b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -41,7 +41,6 @@ https://github.com/DecisiveAI/changelogs?tab=readme-ov-file#type - [ ] Other, please specify: ### Does this PR introduce any breaking changes? - - [ ] No - [ ] Yes, and this is why: - [ ] I need help determining if there are any breaking changes From 346ec16e6f4f39d2e55a521164a13361cec3620a Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 14:19:30 -0700 Subject: [PATCH 08/12] one more example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a328f2..15320d2 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Must be one of the following: - `perf`: A type of refactor that specifically improves performance - `test`: Adding missing tests or correcting existing tests - `revert`: Reverts a previous commit - - *Note: For revert type, `` must be the commit message of the commit its reverting.* + - *Note: For revert type, `` must be the commit message of the commit its reverting (e.g., `revert: fix: fix container/service builder`).* - `build`: Affect build-related components (e.g., build tools, dependencies, project version, CI/CD pipelines, etc) - `chore`: Miscellaneous commits (e.g., modifying `.gitignore`) From dd5fc5832684a46d51a89954fda4105ffac72a20 Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 7 Nov 2025 14:20:44 -0700 Subject: [PATCH 09/12] add jira ticket stuff to template --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9768f3b..75fbc0b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,6 +14,8 @@ Before submitting a pull request, please ensure you've done the following: ## Description - +- ENG- ## What type of PR is this? (only check one) +- [ ] Yes +- [ ] N/A +- [ ] I need help \ No newline at end of file From dd7d54ceb3c8eb610a0e96d81b38370a94846b2c Mon Sep 17 00:00:00 2001 From: xhsun Date: Fri, 14 Nov 2025 09:38:06 -0700 Subject: [PATCH 12/12] address comment --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15320d2..3046d1e 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,9 @@ Title of a pull request must follow the [conventional commit](https://www.conven Must be one of the following: - `feat`: Add or change a feature -- `fix`: Fixes issue with the codebase +- `fix`: Fixes issue with the codebase (e.g., bug, business logic error, typo, etc) - `security`: A type of fixes that resolve security concerns - - `style`: A type of fixes address code style (e.g., white-space, formatting, missing semi-colons) and do not affect application behavior + - `style`: A type of fixes address code style (e.g., white-space, formatting, missing semi-colons, etc) and do not affect application behavior - `doc`: Documentation only changes - `refactor`: Rewrite or restructure code without altering behavior - `perf`: A type of refactor that specifically improves performance