Skip to content

Commit 7422e1f

Browse files
committed
Update GitHub settings and templates.
1 parent a83ac4e commit 7422e1f

File tree

5 files changed

+58
-54
lines changed

5 files changed

+58
-54
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
## Issue type
22
I'm submitting a (check one):
3-
<pre><code>
3+
```
44
[ ] Bug report
55
[ ] Feature request
66
[ ] Regression (something that used to work, but stopped working in a newer version)
77
[ ] Support request
88
[ ] Documentation issue or request
9-
</code></pre>
9+
```
1010

1111
## Prerequisites
12-
Befor posting, make sure you do the following (check all):
13-
<pre><code>
14-
[ ] Search GitHub for a similar issue or PR
15-
[ ] If submitting a Support request, also search [Stack Overflow](https://stackoverflow.com/search?q=angular2+json+schema+form) for similar issues
16-
Note: Please cross-post all GitHub support requests to [Stack Overflow](https://stackoverflow.com/search?q=angular2+json+schema+form), and include a link in your GitHub issue to your Stack Overflow question. At the moment, we will respond to support requests on both GitHub and Stack Overflow (and we check GitHub more often). But eventually we expect to stop answering support issues on GitHub and refer all support questions exclusively to Stack Overflow.
17-
[ ] If submitting a Regression, include the version numbers for both the earlier working and later broken versions
12+
Before posting, make sure you do the following (check all):
13+
```
1814
[ ] Confirm you are using the latest versions of all necessary packages (or if not, explain why not)
19-
</code></pre>
15+
[ ] Search GitHub for a similar issue or PR
16+
[ ] If submitting a Support request, also search [Stack Overflow][stack-overflow] for similar issues
17+
Note: Please cross-post GitHub support requests to [Stack Overflow][stack-overflow], and include a link in your GitHub issue to your Stack Overflow question. We do currently respond to support requests on GitHub, but we eventually expect to stop, and will then refer all support questions exclusively to Stack Overflow.
18+
```
2019

2120
## Current behavior
2221
<!-- Describe what is currently happening. -->
@@ -26,25 +25,33 @@ Note: Please cross-post all GitHub support requests to [Stack Overflow](https://
2625
<!-- Describe what you think should happen instead. -->
2726

2827

29-
## How to reproduce the problem
28+
## IMPORTANT: How can we reproduce your problem?
3029
<!--
31-
Ideally, if you can create a JSON object with the relevant data/schema/layout/options/etc. that will cause the problem to occur in the [demonstration playground](https://angular2-json-schema-form.firebaseapp.com), just paste that JSON here.
32-
33-
If that is not possible, describe the minimum step-by-step procedure necessary to reproduce the problem.
30+
In order to fix your problem, we _must_ first reproduce it.
3431
35-
If the problem is not simple to reproduce, please link to a minimal demo of the problem in a GitHub repository or [Plnkr](https://plnkr.co) example.
36-
-->
32+
Ideally, if you can cause the problem in the [demonstration playground][demonstration-playground], just copy the entire contents of the "Input JSON Schema and Form Layout" text area and paste it here.
3733
34+
If you cannot recreate the problem in the demonstration playground (for example, if it's an installation error or a conflict with another library), then describe the minimum step-by-step procedure necessary to reproduce it.
3835
39-
## Any other relevant information
40-
<!-- e.g. If this is a feature request, what is the use case for the new feature? -->
36+
If the problem is not simple to reproduce, link to a minimal demo of the problem in a GitHub repository or [JSFiddle][jsfiddle] or [Plnkr][plnkr] example.
37+
-->
4138

4239

4340
## Environment
44-
<pre><code>
41+
```
4542
OS name & version:
4643
Browser name & version:
4744
Angular version:
48-
Angular JSON Schema Form version:
45+
Angular JSON Schema Form version(s):
4946
Other relevant software or packages:
50-
</code></pre>
47+
```
48+
<!-- If submitting a Regression, make sure to include the version numbers for both the earlier working and later broken versions of Angular JSON Schema Form. -->
49+
50+
## Any other relevant information
51+
<!-- e.g. If this is a feature request, what is the use case for the new feature? -->
52+
53+
54+
[demonstration-playground]: https://angular2-json-schema-form.firebaseapp.com
55+
[stack-overflow]: https://stackoverflow.com/search?q=angular2+json+schema+form
56+
[jsfiddle]: http://jsfiddle.net
57+
[plunker]: http://plnkr.co/edit

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## PR Type
22
What changes does this PR include (check all that apply)?
3-
<pre><code>
3+
```
44
[ ] Bugfix
55
[ ] Feature
66
[ ] Code style update (formatting, local variables)
77
[ ] Refactoring (no functional changes, no api changes)
88
[ ] Build process changes
99
[ ] Documentation changes
1010
[ ] Other... please describe:
11-
</code></pre>
11+
```
1212

1313
## Related issue / current behavior
1414
<!-- Please link to the issue you are resolving, or describe the current behavior that you are modifying. -->
@@ -19,10 +19,10 @@ What changes does this PR include (check all that apply)?
1919

2020

2121
## Does this PR introduce a breaking change?
22-
<pre><code>
22+
```
2323
[ ] Yes
2424
[ ] No
25-
</code></pre>
25+
```
2626
<!-- If this PR contains a breaking change, how will it affect existing applications? What must those applications do to use the updated library after this change is implemented? -->
2727

2828

.gitignore

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,46 @@
11
# See http://help.github.com/ignore-files/ for more about ignoring files.
22

33
# compiled output
4-
/compiled
5-
/dist
6-
/docs/api
7-
/out-ngc
8-
/tmp
4+
compiled
5+
dist
6+
docs/api
7+
out-ngc
8+
tmp
99

1010
# dependencies
11-
/node_modules
11+
node_modules
1212

1313
# IDEs and editors
14-
/.idea
14+
.idea
1515
.project
1616
.classpath
1717
.c9/
1818
*.launch
1919
.settings/
2020
*.sublime-workspace
21-
22-
# IDE - VSCode
2321
.vscode/*
2422
!.vscode/settings.json
2523
!.vscode/tasks.json
2624
!.vscode/launch.json
2725
!.vscode/extensions.json
2826

2927
# misc
30-
/.sass-cache
31-
/connect.lock
32-
/coverage
33-
/libpeerconnection.log
28+
.sass-cache
29+
connect.lock
30+
coverage
31+
libpeerconnection.log
3432
npm-debug.log
3533
testem.log
36-
/typings
34+
typings
3735
.firebaserc
3836
firebase.json
3937
firebase-debug.log
4038

4139
# e2e
42-
/e2e/*.js
43-
/e2e/*.map
40+
e2e/*.js
41+
e2e/*.map
4442

45-
# System Files
43+
# system files
4644
.DS_Store
45+
Desktop.ini
4746
Thumbs.db

.npmignore

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,28 @@ src
33
compiled
44
out-ngc
55
docs
6+
node_modules
7+
*.log
68

79
# Config
810
.angular-cli.json
911
.editorconfig
12+
.firebaserc
1013
.gitignore
14+
.npmignore
15+
firebase.json
1116
tslint.json
1217
typedoc.json
1318

14-
# Node
15-
node_modules
16-
npm-debug.log
17-
18-
# IDE & OS
19+
# IDE
1920
.idea
2021
.project
2122
.settings
2223
.idea/*
2324
*.iml
2425
*.swp
25-
Thumbs.db
26-
Desktop.ini
27-
.DS_Store
2826

29-
# Misc
30-
.firebaserc
31-
firebase.json
32-
firebase-debug.log
27+
# System Files
28+
.DS_Store
29+
Desktop.ini
30+
Thumbs.db

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This library is released under the [MIT](https://opensource.org/licenses/MIT) Li
3131

3232

3333
## <a name="coc"></a> Code of Conduct
34-
Be courteous to other people. If you're unclear about how to do that, please read and follow our [Code of Conduct][code-of-conduct].
34+
Be courteous to other people. If you're not sure how to do that, please read and follow our [Code of Conduct][code-of-conduct].
3535

3636
[new-issue]: https://github.com/dschnelldavis/angular2-json-schema-form/issues/new
3737
[pull-requests]: https://github.com/dschnelldavis/angular2-json-schema-form/pulls

0 commit comments

Comments
 (0)