├── .github
├── ISSUE_TEMPLATE.md
└── PULL_REQUEST_TEMPLATE.md
├── ISSUE_TEMPLATE.md
├── LICENSE
├── PULL_REQUEST_TEMPLATE.md
├── README.md
└── site
├── img
├── 2book18.jpg
├── 2book3.jpg
├── 2book32.jpg
├── 2book33.jpg
├── 2book35.jpg
├── 2book36.jpg
├── 451px-Maelstrom-Clarke.jpg
├── alice25a.gif
├── angelsversusdemons.jpg
├── cheshire_cat.jpg
├── cover.jpg
├── cyoa.png
├── file.png
├── site-screenshot.png
└── tweet.png
├── index.html
├── js
├── download.min.js
└── main.js
├── style
└── main.css
└── templates
├── issues
├── description
│ ├── bug-or-feature.md
│ ├── bug.md
│ └── feature.md
└── environment
│ ├── browser-and-server.md
│ ├── browser.md
│ └── server.md
└── pull-requests
├── change-types
└── bug-or-feature.md
├── checklist
├── contributing.md
├── intro.md
└── tests.md
└── description
├── generic.md
└── issue-required.md
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Expected Behavior
4 |
5 |
6 |
7 | ## Current Behavior
8 |
9 |
10 |
11 | ## Possible Solution
12 |
13 |
14 |
15 | ## Steps to Reproduce (for bugs)
16 |
17 |
18 | 1.
19 | 2.
20 | 3.
21 | 4.
22 |
23 | ## Context
24 |
25 |
26 |
27 | ## Your Environment
28 |
29 | * Version used:
30 | * Browser name and version:
31 | * Operating System and version (desktop or mobile):
32 | * Link to your project:
33 |
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Description
4 |
5 |
6 | ## Motivation and Context
7 |
8 |
9 |
10 | ## How Has This Been Tested?
11 |
12 |
13 |
14 |
15 | ## Screenshots (if appropriate):
16 |
17 | ## Types of changes
18 |
19 | - [ ] Bug fix (non-breaking change which fixes an issue)
20 | - [ ] New feature (non-breaking change which adds functionality)
21 | - [ ] Breaking change (fix or feature that would cause existing functionality to change)
22 |
23 | ## Checklist:
24 |
25 |
26 | - [ ] My code follows the code style of this project.
27 | - [ ] My change requires a change to the documentation.
28 | - [ ] I have updated the documentation accordingly.
29 |
--------------------------------------------------------------------------------
/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Expected Behavior
4 |
5 |
6 |
7 | ## Current Behavior
8 |
9 |
10 |
11 | ## Possible Solution
12 |
13 |
14 |
15 | ## Steps to Reproduce (for bugs)
16 |
17 |
18 | 1.
19 | 2.
20 | 3.
21 | 4.
22 |
23 | ## Context
24 |
25 |
26 |
27 | ## Your Environment
28 |
29 | * Version used:
30 | * Browser name and version:
31 | * Operating System and version (desktop or mobile):
32 | * Link to your project:
33 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2020 Tal Ater
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Description
4 |
5 |
6 | ## Motivation and Context
7 |
8 |
9 |
10 | ## How Has This Been Tested?
11 |
12 |
13 |
14 |
15 | ## Screenshots (if appropriate):
16 |
17 | ## Types of Changes
18 |
19 | - [ ] Bug fix (non-breaking change that fixes an issue)
20 | - [ ] New feature (non-breaking change that adds functionality)
21 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
22 |
23 | ## Checklist:
24 |
25 |
26 | - [ ] My code follows the code style of this project.
27 | - [ ] My change requires a change to the documentation.
28 | - [ ] I have updated the documentation accordingly.
29 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Issue and Pull Request Template Generator
2 | GitHub Issue and Pull Request Templates Generator
8 |
32 |
33 |
34 |
Open Source Templates
35 |
The Curious Case of the Issue and Pull Request Template
36 |
by Tal Ater
37 |
38 |
40 |
41 |
42 |
Chapter 1
43 |
The Overflowing Mailboxes
44 |
45 |
You are standing in an open field west of a white house. The house is a carefully constructed masterpiece, with solid foundations and a beautiful facade matched by an elegant interior.
46 |
Around the back of the house you see a long line of people, all of them holding little white envelopes. They seem very eager to help with the house.
47 |
There are two mailboxes here.
48 |
The first mailbox is simply labeled issues ("as if I don't have enough of my own to deal with", you think to yourself).
49 |
The second is mysteriously labeled - Pull Requests .
50 |
Both are overflowing.
51 |
52 | To open the issues box, turn to page 37 .
53 | To open the pull requests box, turn to page 75 .
54 | Realizing that your boss may be looking over your shoulder, you quickly hit the BOSS key .
55 |
56 |
59 |
Page 37
60 |
A Bottomless Pit
61 |
62 |
You take a deep breath and open the box labeled issues .
63 |
The size of the box's interior surprises you. As you look into it, you are suddenly gripped by a feeling that the box has no bottom.
64 |
As you stare down into the seemingly bottomless pit of the box, you begin to feel a chill running down your spine. It is as if… as if the endless box of issues is staring right back into your soul.
65 |
It feels… judgy.
66 |
67 | Rolling up your sleeves, you decide to take charge of the issues box and turn to page 38 .
68 | Fear overtakes you. You close the box with a high pitched yelp and turn back to page 1 .
69 |
70 |
73 |
Page 38
74 |
Angels and Demons
75 |
76 |
As you reach down into the box, you begin to realize there is a strange order to the madness. You start to notice a pattern in the issues.
77 |
Some take the form of bug reports , grey festering blobs of infinite malevolence.
78 |
Others manifest themselves as great ethereal balls of living energy in the form of ideas. Whispering half truths of promised features, improvements, and changes .
79 |
You furrow your brow as you consider whether you should concentrate on one type of issue, or both.
80 |
85 |
88 |
Page 39
89 |
Two Sides to Every Schwartz
90 |
91 |
As you pull your head out of the issues mailbox, you are startled by a voice coming from behind you.
92 |
"So… what are you?"
93 |
They are standing under a tree, each with an arm round the other’s neck, and you know which is which in a moment, because one of them has `front’ embroidered on his collar, and the other `back’ .
94 |
"I'm sure I'm very sorry, but whatever do you mean?"
95 |
"There are two sides to every Schwartz," says the first. "Front end…"
96 |
"…and back end," adds his brother.
97 |
102 |
105 |
Page 42
106 |
An Unexpected Guest
107 |
108 |
The brothers nod with understanding, give each other a knowing look and disappear into thin air.
109 |
"And that's that," says a voice from the tree above, startling you.
110 |
You look up and see a Cat grinning from ear to ear. Sensing your alarm, the Cat's grin somehow widens even more. You notice that it has very long claws and a great many teeth.
111 |
"Would you tell me, please, which way I ought to go from here?" you ask.
112 |
"That depends a good deal on where you want to get to," says the Cat. "You are either at the end of your road, or its beginning."
113 |
114 | Your journey feels complete, you feel ready to download your ISSUE_TEMPLATE.md
115 | Something feels wrong, you turn around and face the mailboxes again.
116 |
117 |
120 |
Page 98
121 |
Epilogue
122 |
Your journey is complete. Your prize awaits. You are ready to return to The Hub.
123 |
124 |
ISSUE_TEMPLATE.md
125 |
Place this file in your repository's root directory or a .github directory
126 |
127 |
128 |
You copy the contents of the ISSUE_TEMPLATE.md file, and place it in your repository.
129 |
130 | You decide to Star this on GitHub.
131 | "Maybe I should this," you say to no one in particular.
132 | You do not feel ready, you turn around and start again.
133 |
134 |
137 |
Page 75
138 |
Looking-glass House
139 |
140 |
You peer into the mailbox. Through it you see a confused looking person standing in an open field east of a white house.
141 |
Startled, you raise your right hand to your mouth, stifling a scream. You stumble back just in time to see the person through the mailbox stumble back and raise their left hand.
142 |
You regain your composure (feeling a bit silly, having just been startled by a looking glass), and approach the mailbox again.
143 |
"Now, if you'll only attend," says the person visible through the mailbox, "I'll tell you all about Looking-glass House. First, there's the house you can see through the glass—that's just the same as your house, only the things go the other way."
144 |
145 | The bizarre person in the looking glass intrigues you, and you decide to continue the conversation. You turn to page 77 .
146 | The world spins around you, this is too much for you to deal with. You shut the mailbox and turn back to page 1 .
147 |
148 |
151 |
Page 77
152 |
People With Issues
153 |
154 |
Looking through the mailbox, you notice that the line of people coming around the house are all carrying two envelopes. You watch as they pass by the issues mailbox, place one envelope there and proceed to the pull requests mailbox with the second.
155 |
"We only accept pull requests after the matter has been discussed thoroughly in an issue " explains the person through the mailbox.
156 |
160 |
163 |
Page 26
164 |
Driven to Perfection
165 |
166 |
The two of you stare at each other through the looking glass. Looking closer at your mirrored companion, you begin to notice the exhaustion on their face. It is the face of a person testing every single pull request manually.
167 |
"Are you OK?" you ask.
168 |
Your looking glass friend sighs and lowers their gaze.
169 |
"How do you test changes to your code?" they ask.
170 |
174 |
177 |
Page 29
178 |
CONTRIBUTING file
179 |
180 |
As you look more closely at the looking glass house, you begin to wonder 'how do they keep this house so tidy?'
181 |
On the tree next to the looking glass house you see a notice posted. It is hard to make out the words from this distance, but you manage to make out the big red headline saying GИITUBIЯTИOƆ.
182 |
186 |
189 |
Page 56
190 |
An Old Friend
191 |
192 |
As you gaze at the notice on the tree, you suddenly notice a huge grin hovering among the branches of the tree.
193 |
You watch as the grin widens, exposing a mouthful of sharp teeth, startling you beyond words. You squeal in terror, and slam the mailbox shut.
194 |
Feeling cold sweat running down your neck, you slowly turn around. You look up to lowest branches of the tree on your side of the looking glass where a Cat slowly fades into view, beginning with the grin, and ending with the tail.
195 |
"How are you getting on?" says the Cat, as soon as there is mouth enough for it to speak with.
196 |
197 | "I feel ready to download the PULL_REQUEST_TEMPLATE.md file", you say. You expect the cat to be confused by your words, but his grin somehow widens even more.
198 | The cat couldn't have just talked, could it? You feel faint. Your eyes close and you find yourself slipping away. You wake up hours later, back where you started .
199 |
200 |
203 |
Page 99
204 |
Epilogue
205 |
Your journey is complete. Your prize awaits. You are ready to return to The Hub.
206 |
210 |
211 |
You copy the contents of the PULL_REQUEST_TEMPLATE.md file, placing it in your repository.
212 |
213 | You decide to Star this on GitHub.
214 | "Maybe I should this," you say to no one in particular.
215 | You decide to start over and turn back to page 1 .
216 |
217 |
e.length&&(m=e.split("/").pop().split("?")[0],d.href=e,-1!==d.href.indexOf(e)))return a=new XMLHttpRequest,a.open("GET",e,!0),a.responseType="blob",a.onload=function(a){k(a.target.response,m,"application/octet-stream")},a.send(),a;if(/^data\:[\w+\-]+\/[\w+\-]+[,;]/.test(b))return navigator.msSaveBlob?navigator.msSaveBlob(r(b),m):l(b);c=b instanceof g?b:new g([b],{type:a});if(navigator.msSaveBlob)return navigator.msSaveBlob(c,m);if(f.URL)l(f.URL.createObjectURL(c),!0);else{if("string"==typeof c||c.constructor===p)try{return l("data:"+a+";base64,"+f.btoa(c))}catch(n){return l("data:"+a+","+encodeURIComponent(c))}a=new FileReader,a.onload=function(a){l(this.result)},a.readAsDataURL(c)}return!0}});
3 |
--------------------------------------------------------------------------------
/site/js/main.js:
--------------------------------------------------------------------------------
1 | (function(undefined) {
2 | var choices = {};
3 |
4 | var content = {};
5 |
6 | var proMode = false;
7 |
8 | var viewCover = function() {
9 | $('body').scrollTop(0);
10 | $('.page').hide();
11 | $('.cover').show();
12 | }
13 | var viewPage = function(pageNumber) {
14 | $('body').scrollTop(0);
15 | $('.cover').hide();
16 | $('.page').hide();
17 | $('#page-'+pageNumber).show();
18 | };
19 |
20 | var makeChoice = function(pageNumber, choiceKey, choiceValue) {
21 | if (pageNumber === 1) {
22 | choices = {};
23 | }
24 |
25 | choices[choiceKey] = choiceValue;
26 |
27 | fetchContent(choiceKey, choiceValue);
28 |
29 | return viewPage(pageNumber);
30 | };
31 |
32 | var addToChecklist = function(pageNumber, choiceValue) {
33 | choices['checklist'] = choices['checklist'] || {};
34 |
35 | choices['checklist'][choiceValue] = choiceValue;
36 |
37 | fetchContent('checklist', choiceValue);
38 |
39 | return viewPage(pageNumber);
40 | };
41 |
42 | var fetchContent = function(choiceKey, choiceValue, type) {
43 | type = type || choices['type'];
44 | if (['description', 'environment', 'checklist', 'change-types'].indexOf(choiceKey) !== -1) {
45 | var contentKey = type+'-'+choiceKey+'-'+choiceValue;
46 | if (content[contentKey] === undefined) {
47 | $.get( "templates/"+type+"/"+choiceKey+"/"+choiceValue+".md", function(text) {
48 | content[contentKey] = text;
49 | updateTextarea();
50 | });
51 | } else {
52 | updateTextarea();
53 | }
54 | }
55 | };
56 |
57 | var updateTextarea = function() {
58 | var text = '';
59 | if (choices['type'] === 'issues') {
60 | text = content['issues-description-'+choices['description']]+"\n"+
61 | content['issues-environment-'+choices['environment']];
62 | } else if (choices['type'] === 'pull-requests') {
63 | text = content['pull-requests-description-'+choices['description']]+"\n"+
64 | content['pull-requests-change-types-bug-or-feature']+"\n"+
65 | content['pull-requests-checklist-intro'];
66 | ['contributing', 'tests'].forEach(function(checklistItem) {
67 | if (choices['checklist'] && choices['checklist'][checklistItem]) {
68 | text += content['pull-requests-checklist-'+checklistItem];
69 | }
70 | });
71 | }
72 | $('textarea').val(text);
73 | };
74 |
75 | var routes = {
76 | '/': viewCover,
77 | '/page/:pageNumber': viewPage,
78 | '/page/:pageNumber/checklist/:choiceValue': addToChecklist,
79 | '/page/:pageNumber/:choiceKey/:choiceValue': makeChoice
80 | };
81 |
82 | var router = Router(routes);
83 |
84 | router.setRoute('/')
85 |
86 | router.init();
87 |
88 | fetchContent('change-types', 'bug-or-feature', 'pull-requests');
89 | fetchContent('checklist', 'intro', 'pull-requests');
90 |
91 | $('a.file-name').click(function() {
92 | var filename = choices['type'] === 'issues' ? 'ISSUE_TEMPLATE.md' : 'PULL_REQUEST_TEMPLATE.md';
93 | download($('textarea').val(), filename, "text/plain");
94 | return false;
95 | });
96 |
97 | $('#boss-key').click(function() {
98 | var selector = 'p, h1, h2, img, div.author, div.page-number';
99 | proMode = !proMode;
100 | if (proMode) {
101 | $(selector).animate({opacity: 0.07});
102 | } else {
103 | $(selector).animate({opacity: 1});
104 | }
105 | return false;
106 | });
107 |
108 | })()
109 |
--------------------------------------------------------------------------------
/site/style/main.css:
--------------------------------------------------------------------------------
1 | body {
2 | -webkit-font-smoothing: antialiased;
3 | font-family: 'Source Sans Pro', sans-serif;
4 | font-size: 20px;
5 | color: #515151;
6 | font-weight: 300;
7 | line-height: 33px;
8 | }
9 |
10 | .page {
11 | padding: 10px 10px;
12 | width: auto;
13 | }
14 |
15 | .cover {
16 | margin: 10px 10px;
17 | padding: 5px 10px;
18 | width: auto;
19 | text-align: center;
20 | color: #515151;
21 | }
22 | a.cover-link {
23 | text-decoration: none;
24 | }
25 |
26 | .cover h1 {
27 | border-top: 1px solid #00284a;
28 | padding-top: 15px;
29 | margin-top: 21px;
30 | }
31 |
32 | .cover h2 {
33 | border-bottom: 1px solid #00284a;
34 | padding-bottom: 9px;
35 | margin-bottom: 0;
36 | }
37 | img.cover-image {
38 | width: 80%;
39 | margin-top: 15px;
40 | }
41 |
42 | img.cyoa {
43 | margin-top: 27px;
44 | width: 80%;
45 | max-width: 374px;
46 | }
47 | div.author {
48 | text-transform: uppercase;
49 | font-family: 'Ovo', serif;
50 | font-weight: 600;
51 | font-size: 13px;
52 | }
53 |
54 | h1, h2 {
55 | font-family: 'Ovo', serif;
56 | font-weight: 300;
57 | text-align: center;
58 | }
59 |
60 | h1 {
61 | font-size: 55px;
62 | line-height: 50px;
63 | margin-bottom: 0;
64 | }
65 |
66 | h2 {
67 | font-size: 25px;
68 | line-height: 25px;
69 | }
70 |
71 | p {
72 | text-align: justify;
73 | clear: left;
74 | }
75 | p:first-of-type:first-letter {
76 | float: left;
77 | color: #bf9456;
78 | font-size: 75px;
79 | line-height: 60px;
80 | padding-top: 4px;
81 | padding-right: 8px;
82 | padding-left: 3px;
83 | font-family: Georgia;
84 | }
85 | .page img {
86 | width: 40%;
87 | float: right;
88 | margin-left: 10px;
89 | }
90 | #page-37 img {
91 | width: 27%;
92 | }
93 | #page-38 img {
94 | width: 30%;
95 | }
96 | #page-42 img {
97 | width: 30%;
98 | }
99 | #page-75 img {
100 | width: 30%;
101 | }
102 | #page-26 img {
103 | width: 30%;
104 | }
105 | em {
106 | font-weight: 400;
107 | }
108 | a {
109 | font-weight: 400;
110 | color: #bf9456;
111 | }
112 | ul {
113 | clear: left;
114 | }
115 | div.page-number {
116 | text-align: right;
117 | font-size: 15px;
118 | }
119 | div.file-box {
120 | clear: both;
121 | margin: 50px 0 0 0;
122 | padding: 7px 3px 5px 25px;
123 | border: 1px solid #ddd;
124 | line-height: 20px;
125 | font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
126 | background-image: url("../img/file.png");
127 | background-repeat: no-repeat;
128 | background-position: 7px 8px;
129 | color: #888;
130 | }
131 | div.file-box:hover {
132 | background-color: #f3f3f3;
133 | }
134 | div.file-box a {
135 | color: #4078c0;
136 | text-decoration: none;
137 | margin-right: 30px;
138 | }
139 | div.textarea {
140 | border: 1px solid #ddd;
141 | border-top: none;
142 | padding: 2px 5px;
143 | }
144 | textarea {
145 | width: 100%;
146 | border: none;
147 | padding: 0 0;
148 | margin: 0 0;
149 | min-height: 300px;
150 | font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
151 | font-size: 12px;
152 | line-height: 18px;
153 | color: #515151;
154 | }
155 |
156 | img.tweet {
157 | width: auto;
158 | float: none;
159 | margin-left: 0;
160 | height: 22px;
161 | }
162 |
163 | @media (min-width: 992px) {
164 | .page {
165 | padding: 10px 20%;
166 | }
167 | .cover {
168 | margin: 10px 23%;
169 | border: 1px solid #eee;
170 | }
171 | }
172 |
--------------------------------------------------------------------------------
/site/templates/issues/description/bug-or-feature.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Expected Behavior
4 |
5 |
6 |
7 | ## Current Behavior
8 |
9 |
10 |
11 | ## Possible Solution
12 |
13 |
14 |
15 | ## Steps to Reproduce (for bugs)
16 |
17 |
18 | 1.
19 | 2.
20 | 3.
21 | 4.
22 |
23 | ## Context
24 |
25 |
26 |
--------------------------------------------------------------------------------
/site/templates/issues/description/bug.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Description
4 |
5 |
6 | ## Expected Behavior
7 |
8 |
9 | ## Actual Behavior
10 |
11 |
12 | ## Possible Fix
13 |
14 |
15 | ## Steps to Reproduce
16 |
17 |
18 | 1.
19 | 2.
20 | 3.
21 | 4.
22 |
23 | ## Context
24 |
25 |
--------------------------------------------------------------------------------
/site/templates/issues/description/feature.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Detailed Description
4 |
5 |
6 | ## Context
7 |
8 |
9 |
10 | ## Possible Implementation
11 |
12 |
--------------------------------------------------------------------------------
/site/templates/issues/environment/browser-and-server.md:
--------------------------------------------------------------------------------
1 | ## Your Environment
2 |
3 | * Version used:
4 | * Environment name and version (e.g. Chrome 39, node.js 5.4):
5 | * Operating System and version (desktop or mobile):
6 | * Link to your project:
7 |
--------------------------------------------------------------------------------
/site/templates/issues/environment/browser.md:
--------------------------------------------------------------------------------
1 | ## Your Environment
2 |
3 | * Version used:
4 | * Browser name and version:
5 | * Operating System and version (desktop or mobile):
6 | * Link to your project:
7 |
--------------------------------------------------------------------------------
/site/templates/issues/environment/server.md:
--------------------------------------------------------------------------------
1 | ## Your Environment
2 |
3 | * Version used:
4 | * Environment name and version (e.g. PHP 5.4 on nginx 1.9.1):
5 | * Server type and version:
6 | * Operating System and version:
7 | * Link to your project:
8 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/change-types/bug-or-feature.md:
--------------------------------------------------------------------------------
1 | ## Types of Changes
2 |
3 | - [ ] Bug fix (non-breaking change that fixes an issue)
4 | - [ ] New feature (non-breaking change that adds functionality)
5 | - [ ] Breaking change (fix or feature that would cause existing functionality to change)
6 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/checklist/contributing.md:
--------------------------------------------------------------------------------
1 | - [ ] I have read the **CONTRIBUTING** document.
2 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/checklist/intro.md:
--------------------------------------------------------------------------------
1 | ## Checklist:
2 |
3 |
4 | - [ ] My code follows the code style of this project.
5 | - [ ] My change requires a change to the documentation.
6 | - [ ] I have updated the documentation accordingly.
7 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/checklist/tests.md:
--------------------------------------------------------------------------------
1 | - [ ] I have added tests to cover my changes.
2 | - [ ] All new and existing tests passed.
3 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/description/generic.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Description
4 |
5 |
6 | ## Motivation and Context
7 |
8 |
9 |
10 | ## How Has This Been Tested?
11 |
12 |
13 |
14 |
15 | ## Screenshots (if appropriate):
16 |
--------------------------------------------------------------------------------
/site/templates/pull-requests/description/issue-required.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ## Description
4 |
5 |
6 | ## Related Issue
7 |
8 |
9 |
10 |
11 |
12 | ## Motivation and Context
13 |
14 |
15 | ## How Has This Been Tested?
16 |
17 |
18 |
19 |
20 | ## Screenshots (if appropriate):
21 |
--------------------------------------------------------------------------------
34 | 
38 | 
45 | 
62 | 
76 | 
91 | 
108 | 
this," you say to no one in particular.
140 | 
154 | 
166 | 
180 |