doc: pull request format guideline #1
+161
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <!-- | ||
| For Work In Progress pull requests, please use the Draft PR feature. | ||
| For a timely review/response, please avoid force-pushing additional | ||
| commits if your PR already received reviews or comments. | ||
| Before submitting a pull request, please ensure you've done the following: | ||
| - Create small PRs. In most cases this will be possible. | ||
| - Provide tests for your changes. | ||
| - Fill out the pull request template. | ||
| - Ensure your PR title follow the guideline described in: | ||
| https://github.com/DecisiveAI/changelogs?tab=readme-ov-file#pull-request-title | ||
xhsun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| --> | ||
|
|
||
| ## Description | ||
| <!-- | ||
| Please describe the changes you made in this pull request. | ||
| If applicable, please feel free to include screenshots to make it | ||
| easier for reviewers understand your pull request. | ||
| If there are any relevant documentations that help explain your pull | ||
| request, please feel free to include them as well. | ||
| --> | ||
|
|
||
| - ENG-<!--REPLACE THIS WITH JIRA TICKET NUMBER--> | ||
|
|
||
| ## What type of PR is this? (only check one) | ||
| <!-- | ||
| If you need to check more than one (except if the other type is `doc`, | ||
| always do add more doc) to properly capture the PR type, please | ||
| consider splitting up your PR. | ||
decisiveJoe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| If you selected Other, please ensure the type you provided | ||
| is one of the valid types outlined in | ||
| https://github.com/DecisiveAI/changelogs?tab=readme-ov-file#type | ||
|
|
||
| --> | ||
|
|
||
| - [ ] 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 | ||
decisiveJoe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 | ||
xhsun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Added/updated documentation and/or lab? | ||
| <!-- | ||
| If it does not make sense for the changes done in this repository to ever | ||
| need to update lab repo, then feel free to change the wording of this | ||
| section when copied over. | ||
| --> | ||
| - [ ] Yes <!--If applicable, provide lab PR url here--> | ||
| - [ ] N/A | ||
| - [ ] I need help | ||
|
Comment on lines
+61
to
+69
Author
There was a problem hiding this comment. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,87 @@ | ||
| # 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) | ||
| - [Example](#examples) | ||
| - [Pull Request Description](#pull-request-description) | ||
|
|
||
| # Guidelines | ||
|
|
||
| ## Pull Request Format | ||
|
Author
There was a problem hiding this comment. This might be more fitting to go into |
||
|
|
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. What are your thoughts on putting the Jira ticket id (like ENG-999) in the title? Consumers of the changelog won't have any ability to see those jira items, so they probably do not make sense for this... I think we could still put the ticket ID in the branch name though. Pretty sure Jira can still pick that up.
Author
There was a problem hiding this comment. Jira will also picks it up if the ticket ID is in the PR description, I can add the jira ticket ID into the pr template, similar to |
||
|
|
||
| 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: | ||
|
|
||
| <pre> | ||
| <a href="#type"><type></a></font>(<a href="#optional-scope"><optional scope></a>): <a href="#subject"><subject></a> | ||
| </pre> | ||
|
|
||
| #### Type | ||
|
|
||
| Must be one of the following: | ||
|
|
||
| - `feat`: Add or change a feature | ||
| - `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, 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 | ||
| - `test`: Adding missing tests or correcting existing tests | ||
| - `revert`: Reverts a previous commit | ||
| - *Note: For revert type, `<subject>` 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`) | ||
|
|
||
| #### [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) | ||
decisiveJoe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| #### Examples | ||
|
|
||
| ``` | ||
| fix: fix container/service builder | ||
| ``` | ||
| ``` | ||
| feat(mdai-event-hub): add generic webhook action support | ||
| ``` | ||
| ``` | ||
| refactor!: update 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. | ||
|
|
||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link will be broken until this PR is merged in main