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

Update pull_request_template.md #3446

Merged
merged 2 commits into from
Mar 22, 2024
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
54 changes: 38 additions & 16 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Thanks for submitting this pull request for KeY.
Since the project has a strict review policy, please make the
reviewer's job easier by providing the necessary information
in the text below. The comments may remain since they will be
invisible when showing the PR.
in the text below. The comments can be deleted, but may also
remain since they will be invisible when showing the PR.
-->

## Related Issue
Expand All @@ -17,26 +17,48 @@ This pull request addresses #.
<!-- Please give a brief description of what behaviour changes and
why it should be changed. -->

## Plan

<!-- If this pull request is not yet finished, but has open jobs,
please list them here. It helps others to estimate the state of this
PR. This list can and should be adapted as the PR develops.
Items should be crossed out when finished, not deleted.

Remove the section if the PR was finished at submission time.
The following items are examples:
-->
* [ ] Implement feature 1
* [ ] Implement feature 2
* [ ] Code cleanup
* [ ] Document the changes

## Type of pull request

<!--- What types of changes does your code introduce? Put an `x` in the box(es) that apply: -->
<!--- What types of changes does your code introduce?
Delete those lines that do not apply.
-->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Refactoring (behaviour should not change or only minimally change)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] There are changes to the (Java) code
- [ ] There are changes to the taclet rule base
- [ ] There are changes to the deployment/CI infrastructure (gradle, github, ...)
- [ ] Other:
- Bug fix (non-breaking change which fixes an issue)
- Refactoring (behaviour should not change or only minimally change)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
- There are changes to the (Java) code
- There are changes to the taclet rule base
- There are changes to the deployment/CI infrastructure (gradle, github, ...)
- Other:

## Ensuring quality

<!--- How did you make sure that the proposed change improves the code base?
Delete those lines that do not apply.
Please make an effort to delete as few lines as possible. :-)
-->

- [ ] I made sure that introduced/changed code is well documented (javadoc and inline comments).
- [ ] I made sure that new/changed end-user features are well documented (https://github.com/KeYProject/key-docs).
- [ ] I added new test case(s) for new functionality.
- [ ] I have tested the feature as follows: ...
- [ ] I have checked that runtime performance has not deteriorated.
- I made sure that introduced/changed code is well documented (javadoc and inline comments).
- I made sure that new/changed end-user features are well documented (https://github.com/KeYProject/key-docs).
- I added new test case(s) for new functionality.
- I have tested the feature as follows: ...
- I have checked that runtime performance has not deteriorated.

## Additional information and contact(s)

Expand Down
Loading