Skip to content

Commit 15ca92e

Browse files
Added issue and PR templates (#160)
Created templates for issues and pull requests, as per issue #159. The intention is for these templates to be minimalistic and easy to use, yet guide contributors towards including sufficient information so as to enable effective discussions and reviews. The templates are intended to reflect the contribution guidelines, while aligning to generally accepted good practice. The PR template also contains a developer's certificate of origin.
1 parent 19e007d commit 15ca92e

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

.github/ISSUE_TEMPLATE.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!--
2+
Filling out the template is required. Any issue that does not include enough information may be closed at the maintainers' discretion.
3+
-->
4+
5+
### Description
6+
<!-- Describe the proposed or requested change, and explain the type of change. Is it a change to the protocol, to the documentation, or something else? -->
7+
8+
### Motivation
9+
<!-- Why would you like to see this change? -->
10+
11+
### Exemplification
12+
<!-- Can you think of a concrete example illustrating the impact and value of the change? -->
13+
14+
### Benefits
15+
<!-- What would the benefits of introducing this change be? -->
16+
17+
### Possible Drawbacks
18+
<!-- What are the possible side-effects or negative impacts of the change, and why are they outweighed by the benefits? -->

.github/PULL_REQUEST_TEMPLATE.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!--
2+
Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
3+
Any pull request must pass the automated Travis tests.
4+
-->
5+
6+
### Applicable Issues
7+
<!-- Reference any relevant issues here. Every pull request must reference at least one issue to be considered (as per contribution guidelines) -->
8+
9+
### Description of the Change
10+
<!-- We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the sources addressed by this PR recently, so please walk us through the concepts. -->
11+
12+
### Alternate Designs
13+
<!-- Explain what other alternates were considered and why the proposed version was selected -->
14+
15+
### Benefits
16+
<!-- What benefits will be realized by the change? -->
17+
18+
### Possible Drawbacks
19+
<!-- What are the possible side-effects or negative impacts of the change? -->
20+
21+
### Sign-off
22+
<!-- Sign the below certificate of origin, using your full name and e-mail address. -->
23+
<!-- The certificate is copied from https://developercertificate.org/ -->
24+
25+
Developer's Certificate of Origin 1.1
26+
27+
By making a contribution to this project, I certify that:
28+
29+
(a) The contribution was created in whole or in part by me and I
30+
have the right to submit it under the open source license
31+
indicated in the file; or
32+
33+
(b) The contribution is based upon previous work that, to the best
34+
of my knowledge, is covered under an appropriate open source
35+
license and I have the right under that license to submit that
36+
work with modifications, whether created in whole or in part
37+
by me, under the same open source license (unless I am
38+
permitted to submit under a different license), as indicated
39+
in the file; or
40+
41+
(c) The contribution was provided directly to me by some other
42+
person who certified (a), (b) or (c) and I have not modified
43+
it.
44+
45+
(d) I understand and agree that this project and the contribution
46+
are public and that a record of the contribution (including all
47+
personal information I submit with it, including my sign-off) is
48+
maintained indefinitely and may be redistributed consistent with
49+
this project or the open source license(s) involved.
50+
51+
Signed-off-by: <!-- <Your full name> <[email protected]> -->

0 commit comments

Comments
 (0)