Skip to content

Commit

Permalink
update links in the issue templates, closes #1534
Browse files Browse the repository at this point in the history
  • Loading branch information
epoberezkin committed Apr 7, 2021
1 parent b5642ea commit 0358315
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 28 deletions.
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
Please provide all info and reduce your schema and data to the smallest possible size.
This template is for bug or error reports. For other issues please use:
- security vulnerability: https://tidelift.com/security)
- a new feature/improvement: https://ajv.js.org/contribute.html#changes
- browser/compatibility issues: https://ajv.js.org/contribute.html#compatibility
- JSON-Schema standard: https://ajv.js.org/contribute.html#json-schema
- a new feature/improvement: https://ajv.js.org/contributing/#changes
- browser/compatibility issues: https://ajv.js.org/contributing/#compatibility
- JSON-Schema standard: https://ajv.js.org/contributing/#json-schema
- Ajv usage questions: https://gitter.im/ajv-validator/ajv
-->

**What version of Ajv are you using? Does the issue happen if you use the latest version?**

**Ajv options object**

<!-- See https://github.com/ajv-validator/ajv/api.md#options -->
<!-- See https://ajv.js.org/options.html -->

```javascript

Expand All @@ -30,7 +30,7 @@ This template is for bug or error reports. For other issues please use:

**Sample data**

<!-- Please make it as small as posssible to reproduce the issue -->
<!-- Please make it as small as possible to reproduce the issue -->

```json

Expand All @@ -40,8 +40,8 @@ This template is for bug or error reports. For other issues please use:

<!--
Please:
- make it as small as posssible to reproduce the issue
- use one of the usage patterns from https://github.com/ajv-validator/ajv#getting-started
- make it as small as possible to reproduce the issue
- use one of the usage patterns from https://ajv.js.org/guide/getting-started.html
- use `options`, `schema` and `data` as variables, do not repeat their values here
- post a working code sample in RunKit notebook cloned from https://runkit.com/esp/ajv-issue and include the link here.
Expand Down
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-or-error-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ assignees: ""
---

<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
Please provide all info and reduce your schema and data to the smallest possible size.
This template is for bug or error reports.
For other issues please see https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md
For other issues please see https://ajv.js.org/contributing/
-->

**What version of Ajv are you using? Does the issue happen if you use the latest version?**

**Ajv options object**

<!-- See https://github.com/ajv-validator/ajv/api.md/api.md#options -->
<!-- See https://ajv.js.org/options.html -->

```javascript

Expand All @@ -34,7 +34,7 @@ For other issues please see https://github.com/ajv-validator/ajv/blob/master/CON

**Sample data**

<!-- Please make it as small as posssible to reproduce the issue -->
<!-- Please make it as small as possible to reproduce the issue -->

```json

Expand All @@ -44,8 +44,8 @@ For other issues please see https://github.com/ajv-validator/ajv/blob/master/CON

<!--
Please:
- make it as small as posssible to reproduce the issue
- use one of the usage patterns from https://github.com/ajv-validator/ajv#getting-started
- make it as small as possible to reproduce the issue
- use one of the usage patterns from https://ajv.js.org/guide/getting-started.html
- use `options`, `schema` and `data` as variables, do not repeat their values here
- post a working code sample in RunKit notebook cloned from https://runkit.com/esp/ajv-issue and include the link here.
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/change.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ""
---

<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
Please provide all info and reduce your schema and data to the smallest possible size.
This template is for change proposals.
For other issues please see https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md
For other issues please see https://ajv.js.org/contributing/
-->

**What version of Ajv you are you using?**
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ""
---

<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
Please provide all info and reduce your schema and data to the smallest possible size.
This template is for compatibility issues.
For other issues please see https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md
For other issues please see https://ajv.js.org/contributing/
-->

**The version of Ajv you are using**
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ""
---

<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
Please provide all info and reduce your schema and data to the smallest possible size.
This template is for installation and dependency issues.
For other issues please see https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md
For other issues please see https://ajv.js.org/contributing/
Before submitting the issue, please try the following:
- use the latest stable Node.js and npm
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ assignees: ""
---

<!--
Frequently Asked Questions: https://github.com/ajv-validator/ajv/blob/master/docs/faq.md
Frequently Asked Questions: https://ajv.js.org/faq.html
This template is for issues about missing or incorrect type definition and other typescript-related issues.
For other issues please see https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md
For other issues please see https://ajv.js.org/contributing/
-->

**What version of Ajv are you using? Does the issue happen if you use the latest version?**

**Your typescript code**

<!--
Please make it as small as posssible to reproduce the issue
Please make it as small as possible to reproduce the issue
-->

```typescript
Expand Down
20 changes: 15 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ Tidelift will coordinate the fix and disclosure.

Please do NOT report security vulnerabilities via GitHub issues.

### <a name="changes"></a>Change proposals
<a name="changes"></a>

### Change proposals

[Create a proposal](https://github.com/ajv-validator/ajv/issues/new?template=change.md) for a new feature, option or some other improvement.

Expand All @@ -77,7 +79,9 @@ If you’re requesting a change, it would be helpful to include this as well:

Please include as much details as possible - the more information, the better.

### <a name="compatibility"></a>Browser and compatibility issues
<a name="compatibility"></a>

### Browser and compatibility issues

[Create an issue](https://github.com/ajv-validator/ajv/issues/new?template=compatibility.md) to report a compatibility problem that only happens in a particular environment (when your code works correctly in the latest stable Node.js in linux systems but fails in some other environment).

Expand All @@ -90,7 +94,9 @@ Please include this information:
5. Results in the latest stable Node.js.
6. Results and error messages in your platform.

### <a name="installation"></a>Installation and dependency issues
<a name="installation"></a>

### Installation and dependency issues

[Create an issue](https://github.com/ajv-validator/ajv/issues/new?template=installation.md) to report problems that happen during Ajv installation or when Ajv is missing some dependency.

Expand All @@ -109,13 +115,17 @@ If nothing helps, please submit:
5. Error messages
6. The output of `npm ls`

### <a name="json-schema"></a>Using JSON Schema standard
<a name="json-schema"></a>

### Using JSON Schema standard

Ajv implements JSON Schema standard draft-04 and draft-06/07.

If it is a general issue related to using the standard keywords included in JSON Schema specification or implementing some advanced validation logic please ask the question on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=jsonschema,ajv) (my account is [esp](https://stackoverflow.com/users/1816503/esp)) or submit the question to [json-schema.org](https://github.com/json-schema-org/json-schema-spec/issues/new). Please mention @epoberezkin.

### <a name="usage"></a>Ajv usage questions
<a name="usage"></a>

### Ajv usage questions

The best place to ask a question about using Ajv is [Gitter chat](https://gitter.im/ajv-validator/ajv).

Expand Down

0 comments on commit 0358315

Please sign in to comment.