Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: create pull request template #1936

Merged
merged 5 commits into from
Aug 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pr-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<!-- PLEASE USE THE TEMPLATE SECTION THAT IS APPLICABLE FOR YOUR CONTRIBUTION -->

<!-- CODE SECTION -->
<!-- USE THIS FOR CODE CONTRIBUTIONS -->

# Description

Please include a short summary of the changes and the related issue.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

# How to test

Please describe how to run the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also provide information about any automatic tests that you added.

- [ ] Manual Test A
- [ ] Unit Test B
- [ ] Integration Test C

# Checklist

- [ ] My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
into multiple PRs)
- [ ] I used descriptive commit messages to help reviewers understand my thought process
- [ ] I signed off all my commits according to the Developer Certificate of Origin (DCO) (
see [Contribution Guide](https://github.com/keptn/lifecycle-toolkit/blob/main/CONTRIBUTING.md#submit-a-pull-request-))
- [ ] My PR title is formatted according to the semantic PR conventions described in
the [Contribution Guide](https://github.com/keptn/lifecycle-toolkit/blob/main/CONTRIBUTING.md#submit-a-pull-request-)
- [ ] My code follows the style guidelines of this project (golangci-lint passes, YAMLLint passes)
- [ ] I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
- [ ] I have performed a self-review of my code
- [ ] I have made corresponding changes to the documentation (if needed)
- [ ] My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test
runs)
- [ ] New and existing unit and integration tests pass locally with my changes

<!-- DOCS SECTION -->
<!-- USE THIS FOR DOCS CONTRIBUTIONS -->

# Summary

Please include a short summary of the changes and the related issue.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

# Checks

- [ ] My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
into multiple PRs)
- [ ] I used descriptive commit messages to help reviewers understand my thought process
- [ ] I signed off all my commits according to the Developer Certificate of Origin (DCO) (
see [Contribution Guide](https://github.com/keptn/lifecycle-toolkit/blob/main/docs/CONTRIBUTING.md#developer-certification-of-origin-dco))
- [ ] My PR title is formatted according to the semantic PR conventions described in
the [Contribution Guide](https://github.com/keptn/lifecycle-toolkit/blob/main/CONTRIBUTING.md#submit-a-pull-request-)
- [ ] My content follows the style guidelines of this project (YAMLLint, markdown-lint)
- [ ] I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
- [ ] I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
from the Netlify deploy preview
- [ ] My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test
runs)