mirror of
https://github.com/zitadel/zitadel
synced 2024-11-22 00:39:36 +00:00
chore: improve commit messages (#7921)
* chore: improve commit messages * indent * cleanup * additional changes --------- Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
This commit is contained in:
parent
e4905f1431
commit
3396657c3f
40
.github/pull_request_template.md
vendored
40
.github/pull_request_template.md
vendored
@ -1,15 +1,27 @@
|
||||
### Definition of Ready
|
||||
# Which Problems Are Solved
|
||||
|
||||
- [ ] I am happy with the code
|
||||
- [ ] Short description of the feature/issue is added in the pr description
|
||||
- [ ] PR is linked to the corresponding user story
|
||||
- [ ] Acceptance criteria are met
|
||||
- [ ] All open todos and follow ups are defined in a new ticket and justified
|
||||
- [ ] Deviations from the acceptance criteria and design are agreed with the PO and documented.
|
||||
- [ ] No debug or dead code
|
||||
- [ ] My code has no repetitions
|
||||
- [ ] Critical parts are tested automatically
|
||||
- [ ] Where possible E2E tests are implemented
|
||||
- [ ] Documentation/examples are up-to-date
|
||||
- [ ] All non-functional requirements are met
|
||||
- [ ] Functionality of the acceptance criteria is checked manually on the dev system.
|
||||
Replace this example text with a concise list of problems that this PR solves.
|
||||
For example:
|
||||
- If the property XY is not given, the system crashes with a nil pointer exception.
|
||||
|
||||
# How the Problems Are Solved
|
||||
|
||||
Replace this example text with a concise list of changes that this PR introduces.
|
||||
For example:
|
||||
- Validates if property XY is given and throws an error if not
|
||||
|
||||
# Additional Changes
|
||||
|
||||
Replace this example text with a concise list of additional changes that this PR introduces, that are not directly solving the initial problem but are related.
|
||||
For example:
|
||||
- The docs explicitly describe that the property XY is mandatory
|
||||
- Adds missing translations for validations.
|
||||
|
||||
# Additional Context
|
||||
|
||||
Replace this example with links to related issues, discussions, discord threads, or other sources with more context.
|
||||
Use the Closing #issue syntax for issues that are resolved with this PR.
|
||||
- Closes #123
|
||||
- Discussion #456
|
||||
- Follow-up for PR #789
|
||||
- https://discord.com/channels/123/456
|
31
.github/workflows/ready_for_review.yml
vendored
Normal file
31
.github/workflows/ready_for_review.yml
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened]
|
||||
|
||||
jobs:
|
||||
comment:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const content = `### Thanks for your contribution! 🎉
|
||||
|
||||
Please make sure you tick the following checkboxes before marking this Pull Request (PR) as ready for review:
|
||||
|
||||
- [ ] I am happy with the code
|
||||
- [ ] Documentations and examples are up-to-date
|
||||
- [ ] Logical behavior changes are tested automatically
|
||||
- [ ] No debug or dead code
|
||||
- [ ] My code has no repetitions
|
||||
- [ ] The PR title adheres to the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
- [ ] The example texts in the PR description are replaced.
|
||||
- [ ] If there are any open TODOs or follow-ups, they are described in issues and link to this PR
|
||||
- [ ] If there are deviations from a user stories acceptance criteria or design, they are agreed upon with the PO and documented.
|
||||
`;
|
||||
github.rest.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: content
|
||||
})
|
Loading…
Reference in New Issue
Block a user