Skip to content

Commit 39eb9c5

Browse files
nmanovicNikita Manovich
authored and
Nikita Manovich
committed
Add pull request and issue templates (#1359)
* Add initial version of pull request template * Fix links * Fix codacy issues * Slightly improve titles of sections * Add a note about strikethough for the checklist. * Fix progress of a pull request (each checkbox is an issue) * Add the license header, checkboxes about the license. * Updated the license * Update the license to met https://github.com/licensee/licensee/blob/master/vendor/choosealicense.com/_licenses/mit.txt restrictions. * Fix the pull request template name * Make explaination text as comments (it will be visible when you edit the PR message) * Add initial version of the issue template.
1 parent feebec2 commit 39eb9c5

File tree

3 files changed

+102
-2
lines changed

3 files changed

+102
-2
lines changed

.github/ISSUE_TEMPLATE.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<!---
2+
Copyright (C) 2020 Intel Corporation
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
7+
### My actions before raising this issue
8+
- [ ] Read/searched [the docs](https://github.com/opencv/cvat/tree/master#documentation)
9+
- [ ] Searched [past issues](/issues)
10+
11+
<!--- Provide a general summary of the issue in the Title above -->
12+
13+
### Expected Behaviour
14+
<!--- If you're describing a bug, tell us what should happen. If you're
15+
suggesting a change/improvement, tell us how it should work -->
16+
17+
### Current Behaviour
18+
<!--- If describing a bug, tell us what happens instead of the expected
19+
behavior. If suggesting a change/improvement, explain the difference from
20+
current behavior -->
21+
22+
### Possible Solution
23+
<!--- Not obligatory, but suggest a fix/reason for the bug, or ideas how
24+
to implement the addition or change -->
25+
26+
### Steps to Reproduce (for bugs)
27+
<!--- Provide a link to a live example, or an unambiguous set of steps to
28+
reproduce this bug. Include code to reproduce, if relevant -->
29+
1.
30+
1.
31+
1.
32+
1.
33+
34+
### Context
35+
<!--- How has this issue affected you? What are you trying to accomplish?
36+
Providing context helps us come up with a solution that is most useful in
37+
the real world -->
38+
39+
### Your Environment
40+
<!--- Include as many relevant details about the environment you experienced
41+
the bug in -->
42+
- Git hash commit (`git log -1`):
43+
- Docker version `docker version` (e.g. Docker 17.0.05):
44+
- Are you using Docker Swarm or Kubernetes?
45+
- Operating System and version (e.g. Linux, Windows, MacOS):
46+
- Code example or link to GitHub repo or gist to reproduce problem:
47+
- Other diagnostic information / logs:
48+
<details>
49+
<summary>Logs from `cvat` container</summary>
50+
</details>
51+
52+
### Next steps
53+
You may [join our Gitter](https://gitter.im/opencv-cvat/public) channel for community support.

.github/PULL_REQUEST_TEMPLATE.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!---
2+
Copyright (C) 2020 Intel Corporation
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
7+
<!-- Provide a general summary of your changes in the Title above -->
8+
9+
### Motivation and context
10+
<!-- Why is this change required? What problem does it solve? If it fixes an open
11+
issue, please link to the issue here. Describe your changes in detail, add
12+
screenshots. -->
13+
14+
### How has this been tested?
15+
<!-- Please describe in detail how you tested your changes.
16+
Include details of your testing environment, and the tests you ran to
17+
see how your change affects other areas of the code, etc. -->
18+
19+
### Checklist
20+
<!-- Go over all the following points, and put an `x` in all the boxes that apply.
21+
If an item isn't applicable by a reason then ~~explicitly strikethrough~~ the whole
22+
line. If you don't do that github will show incorrect process for the pull request.
23+
If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
24+
25+
- [ ] I have raised an issue to propose this change ([required](https://github.com/opencv/cvat/issues))
26+
- [ ] My issue has received approval from the maintainers
27+
- [ ] I've read the [CONTRIBUTION](https://github.com/opencv/cvat/blob/develop/CONTRIBUTING.md) guide
28+
- [ ] I have added description of my changes into [CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md) file
29+
- [ ] I have updated the [documentation](
30+
https://github.com/opencv/cvat/blob/develop/README.md#documentation) accordingly
31+
- [ ] I have added tests to cover my changes
32+
- [ ] I have linked related issues ([read github docs](
33+
https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
34+
35+
### License
36+
37+
- [ ] I submit _my code changes_ under the same [MIT License](
38+
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the project.
39+
Feel free to contact the maintainers if that's a concern.
40+
- [ ] I have updated the license header for each file (see an example below)
41+
42+
```python
43+
# Copyright (C) 2020 Intel Corporation
44+
#
45+
# SPDX-License-Identifier: MIT
46+
```

LICENSE

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Copyright (C) 2018 Intel Corporation
1+
MIT License
2+
3+
Copyright (C) 2018-2020 Intel Corporation
24

35
Permission is hereby granted, free of charge, to any person obtaining a copy
46
of this software and associated documentation files (the "Software"),
@@ -18,4 +20,3 @@ OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
1820
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
1921
OR OTHER DEALINGS IN THE SOFTWARE.
2022

21-
SPDX-License-Identifier: MIT

0 commit comments

Comments
 (0)