Skip to content

Commit f274c6d

Browse files
authored
Update the PR template (#1856)
This pull request updates the `.github/pull_request_template.md` file to improve the clarity and usefulness of pull request descriptions and checklists. The changes focus on guiding contributors to provide better summaries and references, streamlining the checklist, and removing redundant sections. Improvements to PR description guidance: * Added instructions encouraging contributors to provide a more comprehensive summary, including relevant facts, design choices, and testing procedures, and clarified how to reference related issues and pull requests. Checklist and documentation updates: * Simplified the checklist by merging unit and integration test items, and clarified requirements for documenting manual tests and changelog updates. * Removed redundant license section and example license header, streamlining the template for easier use. <!-- Contributing guide: https://github.com/open-edge-platform/datumaro/blob/develop/CONTRIBUTING.md --> ### Summary <!-- Resolves #111 and #222. Depends on #1000 (for series of dependent commits). This PR introduces this capability to make the project better in this and that. - Added this feature - Removed that feature - Fixed the problem #1234 --> ### How to test <!-- Describe the testing procedure for reviewers, if changes are not fully covered by unit tests or manual testing can be complicated. --> ### Checklist <!-- Put an 'x' in all the boxes that apply --> - [ ] I have added unit tests to cover my changes.​ - [ ] I have added integration tests to cover my changes.​ - [ ] I have added the description of my changes into [CHANGELOG](https://github.com/open-edge-platform/datumaro/blob/develop/CHANGELOG.md).​ - [ ] I have updated the [documentation](https://github.com/open-edge-platform/datumaro/tree/develop/docs) accordingly ### License - [ ] I submit _my code changes_ under the same [MIT License](https://github.com/open-edge-platform/datumaro/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. - [ ] I have updated the license header for each file (see an example below). ```python # Copyright (C) 2025 Intel Corporation # # SPDX-License-Identifier: MIT ```
2 parents a6119de + b54a792 commit f274c6d

File tree

2 files changed

+9
-27
lines changed

2 files changed

+9
-27
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,18 @@
1-
<!-- Contributing guide: https://github.com/open-edge-platform/datumaro/blob/develop/CONTRIBUTING.md -->
21

3-
### Summary
2+
3+
<!-- Contributing guide: https://github.com/open-edge-platform/datumaro/blob/develop/CONTRIBUTING.md -->
44

55
<!--
6-
Resolves #111 and #222.
7-
Depends on #1000 (for series of dependent commits).
6+
Please add a summary of changes. You may use Copilot to auto-generate the PR description but please consider including any other relevant facts which Copilot may be unaware of (such as design choices and testing procedure).
87
9-
This PR introduces this capability to make the project better in this and that.
8+
Add references to the relevant issues and pull requests if any like so:
109
11-
- Added this feature
12-
- Removed that feature
13-
- Fixed the problem #1234
10+
Resolves #111 and #222.
11+
Depends on #1000 (for series of dependent commits).
1412
-->
1513

16-
### How to test
17-
<!-- Describe the testing procedure for reviewers, if changes are
18-
not fully covered by unit tests or manual testing can be complicated. -->
19-
2014
### Checklist
2115
<!-- Put an 'x' in all the boxes that apply -->
22-
- [ ] I have added unit tests to cover my changes.​
23-
- [ ] I have added integration tests to cover my changes.​
24-
- [ ] I have added the description of my changes into [CHANGELOG](https://github.com/open-edge-platform/datumaro/blob/develop/CHANGELOG.md).​
16+
- [ ] I have added tests to cover my changes or documented any manual tests.
17+
- [ ] I have added the description of my changes into [CHANGELOG](https://github.com/open-edge-platform/datumaro/blob/develop/CHANGELOG.md).
2518
- [ ] I have updated the [documentation](https://github.com/open-edge-platform/datumaro/tree/develop/docs) accordingly
26-
27-
### License
28-
29-
- [ ] I submit _my code changes_ under the same [MIT License](https://github.com/open-edge-platform/datumaro/blob/develop/LICENSE) that covers the project.
30-
Feel free to contact the maintainers if that's a concern.
31-
- [ ] I have updated the license header for each file (see an example below).
32-
33-
```python
34-
# Copyright (C) 2025 Intel Corporation
35-
#
36-
# SPDX-License-Identifier: MIT
37-
```

.markdownlintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pull_request_template.md

0 commit comments

Comments
 (0)