Commit f274c6d
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 files changed
+9
-27
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | 1 | | |
3 | | - | |
| 2 | + | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
| 6 | + | |
8 | 7 | | |
9 | | - | |
| 8 | + | |
10 | 9 | | |
11 | | - | |
12 | | - | |
13 | | - | |
| 10 | + | |
| 11 | + | |
14 | 12 | | |
15 | 13 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | 14 | | |
21 | 15 | | |
22 | | - | |
23 | | - | |
24 | | - | |
| 16 | + | |
| 17 | + | |
25 | 18 | | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
0 commit comments