doc: pull request format guideline #1
Conversation
| - 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 |
There was a problem hiding this comment.
This link will be broken until this PR is merged in main
| 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 |
|
|
||
| # Guidelines | ||
|
|
||
| ## Pull Request Format |
There was a problem hiding this comment.
This might be more fitting to go into CONTRIBUTING.md, but I really don't feel like writing a whole contribution guideline right now... So it will stay in the readme until we have a clear contribution guideline...
|
|
||
| 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 |
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.
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
| ## 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 No newline at end of file |
There was a problem hiding this comment.
Description
Goal of this PR is to add pull request format guideline to let people know how we expect a pull request title and description to layout. And also to provide a sample that can be used as reference.
What type of PR is this? (only check one)
feat)fix)refactor)doc)Does this PR introduce any breaking changes?
Does the PR title type prefix match the selected type?
Added/updated tests?
Please keep the code coverage percentage at 80% and above.