diff --git a/.github/ISSUE_TEMPLATE/bug-or-error-report.md b/.github/ISSUE_TEMPLATE/bug-or-error-report.md index 3da68b7..42c3519 100644 --- a/.github/ISSUE_TEMPLATE/bug-or-error-report.md +++ b/.github/ISSUE_TEMPLATE/bug-or-error-report.md @@ -2,7 +2,7 @@ name: Bug or error report about: Please use for issues related to incorrect validation behaviour title: '' -labels: '' +labels: 'bug report' assignees: '' --- diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..60b3fab --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,28 @@ +# Please supply comments to be used for GitHub labels +githubLabels: + bug: > + Bug confirmed - to be fixed. PR is welcome! + +# duplicate: > +# enhancement: > +# good first issue: > +# help wanted: > +# invalid: > +# question: > +# wont fix: > + + bug report: > + Thank you for the report! If you didn't post a code sample to RunKit yet, + please clone this notebook https://runkit.com/esp/ajv-issue, + post the code sample that demonstrates the bug and post the link here. + It will speed up the investigation and fixing! + + json schema: > + This question is about the usage of JSON Schema specification - it is not specific to Ajv. + Please use JSON Schema reference materials or [submit the question to Stack Overflow](https://stackoverflow.com/questions/ask?tags=jsonschema,ajv). + + - [JSON Schema specification](http://json-schema.org/) + - [Tutorial by Space Telescope Science Institute](http://json-schema.org/understanding-json-schema/) + - [validation keywords](https://github.com/epoberezkin/ajv#validation-keywords) (in Ajv docs) + - [combining schemas](https://github.com/epoberezkin/ajv#ref) (in Ajv docs) + - [Tutorial by @epoberezkin](https://code.tutsplus.com/tutorials/validating-data-with-json-schema-part-1--cms-25343) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 897f634..eade3b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,9 @@ Please make sure to include the following information in the issue: 5. Validation result, data AFTER validation, error messages. 6. What results did you expect? -[Create bug report](https://github.com/epoberezkin/ajv/issues/new). +Please include the link to the working code sample at Runkit.com (please clone https://runkit.com/esp/ajv-issue) - it will speed up investigation and fixing. + +[Create bug report](https://github.com/epoberezkin/ajv/issues/new?template=bug-or-error-report.md). #### Change proposals @@ -99,7 +101,7 @@ If nothing helps, please submit: 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 or implementing some advanced validation logic please ask the question on [Stack Overflow](http://stackoverflow.com/questions/ask?tags=jsonschema,ajv) (my account is [esp](http://stackoverflow.com/users/1816503/esp)) or submitting the question to [JSON-Schema.org](https://github.com/json-schema-org/json-schema-spec/issues/new). Please mention @epoberezkin. +If it is a general issue related to using the standard keywords included in JSON Schema 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 submitting the question to [JSON-Schema.org](https://github.com/json-schema-org/json-schema-spec/issues/new). Please mention @epoberezkin. #### Ajv usage questions