Skip to content

Commit 3def68b

Browse files
committed
Move and edit the pull request template
1 parent ac7da77 commit 3def68b

File tree

2 files changed

+38
-19
lines changed

2 files changed

+38
-19
lines changed

.github/PULL_REQUEST_TEMPLATE/pull-request-template.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.github/pull-request-template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
> Thanks for contributing a pull request! Please ensure you have taken a look at the contribution guidelines: https://github.com/automl/SMAC3/blob/main/CONTRIBUTING.md
2+
3+
#### Reference Issues/PRs
4+
> Example: Fixes #1234. See also #3456.
5+
> Please use keywords (e.g., Fixes) to create link to the issues or pull requests you resolved, so that they will automatically be closed when your pull request is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
6+
7+
#### Description, Motivation and Context
8+
> Provide a short description of your changes.
9+
10+
#### Changes
11+
> Explain your changes in detail here.
12+
13+
#### Type Of Changes
14+
> What types of changes does your code introduce? Put an `x` in all the boxes that apply:
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
18+
19+
#### What is Missing?
20+
> Please provide any further information that is needed to close this PR.
21+
> This could be another PR that is blocking this PR, or any further changes
22+
> that need to be addressed in the future.
23+
24+
#### Checklist
25+
> Go over all the following points, and put an `x` in all the boxes that apply.
26+
> Should there be a good argument to differ, please provide a reasoned explanation.
27+
- [ ] My change is based on the latest stage of the `develop` branch.
28+
- [ ] My change required a change of the documentation, which has been done.
29+
- [ ] I checked that the documentation can be build, visualizes everything as expected, and does not contain any warnings.
30+
- [ ] I have added/adapted tests to cover my changes.
31+
- [ ] The tests can be executed successfully.
32+
- [ ] I have added a description of the changes to `CHANGELOG.rst`.
33+
34+
#### Any other comments?
35+
36+
> We appreciate your effort, but please be aware that we are not working full-time on this project. We welcome any contribution and value your effort, no matter how minor they are. If we are slow to review, either the pull request needs some benchmarking, tinkering, convincing, etc. or more likely the reviewers are simply busy. In either case, we ask for your understanding during the review process.
37+
>
38+
> Thanks for contributing!

0 commit comments

Comments
 (0)