Skip to content

Commit 35fa737

Browse files
authored
Update PR template with requirements for labels and titles (#1714)
* Update PR template with requirements for labels and titles * Update formatting for self-check list * Minor updates
1 parent 61e6fb3 commit 35fa737

File tree

1 file changed

+40
-27
lines changed

1 file changed

+40
-27
lines changed

.github/pull_request_template.md

Lines changed: 40 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,56 @@
1-
# Description
1+
## Labels (hint)
22

3-
Substitute this text with a concise description of the proposed change. Emphasize, why particular solution was chosen.
3+
Choose the obligatory labels:
4+
- "ctg" (category): _bug-fix_, _enhancement_, _refactoring_, etc.
5+
- "comp" (component): _symbolic-engine_, _fuzzing_, _codegen_, etc.
46

5-
Fixes # (issue)
7+
Feel free to apply more labels to your PR, e.g.: _lang-java_, _priority-minor_, _spec-performance_
68

7-
## Type of Change
9+
## Title (hint)
810

9-
Please delete options that are not relevant.
11+
Describe what you've changed or added in terms of functionality.
1012

11-
- Minor bug fix (non-breaking small changes)
12-
- Bug fix (non-breaking change which fixes an issue)
13-
- Refactoring (typos and non-functional changes)
14-
- New feature (non-breaking change which adds functionality)
15-
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
For example:
1614

17-
# How Has This Been Tested?
15+
> Add summaries for the nested classes
1816
19-
## Regression and integration tests
17+
> Support test generation for paths with spaces in JavaScript
2018
21-
Please, provide regression or integration tests for your code changes. If you don't do that, the reviewer can and highly likely **_will reject_** the PR. It is the contributor's responsibility to provide such tests or to reason why they are missing.
19+
> Remove packageName property not defined in Java 8
2220
23-
## Automated Testing
21+
Check that the title contains
22+
* no branch name
23+
* no GitHub nickname
24+
* no copy-pasted issue title
2425

25-
Specify tests that help to verify the change automatically.
26+
## Description
2627

27-
_Example:_ org.utbot.examples.algorithms.BinarySearchTest
28+
- Mention the related issue (_**"Fixes #..."**_) or describe why you've made the changes.
29+
- Add useful info for your reviewer or another contributor.
2830

29-
## Manual Scenario
31+
## How to test
3032

31-
Please, provide several scenarios that you went through to verify that the change worked as expected.
33+
### Automated tests
3234

33-
# Checklist (remove irrelevant options):
35+
Please specify the _automated tests_ for your code changes: you should either mention the existing tests or add the new ones.
3436

35-
_This is the author self-check list_
37+
For example:
3638

37-
- [ ] The change followed the style guidelines of the UTBot project
38-
- [ ] Self-review of the code is passed
39-
- [ ] The change contains enough commentaries, particularly in hard-to-understand areas
40-
- [ ] New documentation is provided or existed one is altered
41-
- [ ] No new warnings
42-
- [ ] New tests have been added
43-
- [ ] All tests pass locally with my changes
39+
> The proposed changes are verified with tests:
40+
> `utbot-fuzzing/src/test/kotlin/org/utbot/fuzzing/FuzzerSmokeTest.kt`
41+
42+
### Manual tests
43+
44+
If it is impossible to provide the automated tests, please reason why. Usually, it is relevant only for UI- or documentation-related PRs.
45+
If this is your case, share the detailed _manual scenarios_ that help to verify your changes.
46+
47+
## Self-check list
48+
49+
Check off the item if the statement is true:
50+
51+
- [ ] I've set the proper **labels** for my PR (at least, for category and component).
52+
- [ ] PR **title** and **description** are clear and intelligible.
53+
- [ ] I've added enough **comments**, particularly in hard-to-understand areas.
54+
- [ ] The functionality I've repaired, changed or added is covered with **automated tests**.
55+
- [ ] **Manual tests** have been provided optionally.
56+
- [ ] The **documentation** for the functionality I've been working on is up-to-date.

0 commit comments

Comments
 (0)