diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 96e73e6..68784e4 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -62,3 +62,6 @@ It would help if you post a working code sample in Tonic notebook and include th ``` **What results did you expect?** + + +**Do you intend to resolve the issue?** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1509c34 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ + + +**What issue does this pull request resolve?** + + +**What changes did you make?** + + +**Is there anything that requires more attention while reviewing?** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a5ee5d..b3bb3be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,11 +103,11 @@ All validation functions are generated using doT templates in [dot](https://gith To make accepting your changes faster please follow these steps: 1. Submit an [issue with the bug](https://github.com/epoberezkin/ajv/issues/new) or with the proposed change (unless the contribution is to fix the documentation typos and mistakes). -2. Please confirm with me the proposed api and implementation plan (unless the issue is a relative simple bug and fixing it doesn't change any api). -3. Write as little code as possible to achieve the desired result. +2. Please describe the proposed api and implementation plan (unless the issue is a relatively simple bug and fixing it doesn't change any api). +3. Once agreed, please write as little code as possible to achieve the desired result. 4. Please avoid unnecessary changes, refactoring or changing coding styles as part of your change (unless the change was proposed as refactoring). 5. Please follow the coding conventions even if they are not validated (and/or you use different conventions in your code). -6. Please run tests before committing your code. +6. Please run the tests before committing your code. 7. If tests fail in Travis after you make a PR please investigate and fix the issue.