diff --git a/.github/PULL_REQUEST_TEMPLATE/CI.md b/.github/PULL_REQUEST_TEMPLATE/CI.md new file mode 100644 index 000000000..14b0dcfb1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/CI.md @@ -0,0 +1,14 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/api.md b/.github/PULL_REQUEST_TEMPLATE/api.md new file mode 100644 index 000000000..590079331 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/api.md @@ -0,0 +1,16 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] This part of API is exported from the corresponding `index.ts` +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md new file mode 100644 index 000000000..1f6ed9b73 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -0,0 +1,16 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have added tests to demonstrate the contribution is correctly implemented: this usually includes both positive and negative tests, showing the happy path(s) and featuring intentionally broken cases +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/code-quality.md b/.github/PULL_REQUEST_TEMPLATE/code-quality.md new file mode 100644 index 000000000..43fce2bb5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/code-quality.md @@ -0,0 +1,18 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/codegen.md b/.github/PULL_REQUEST_TEMPLATE/codegen.md new file mode 100644 index 000000000..ec080b772 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/codegen.md @@ -0,0 +1,16 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have added tests to demonstrate the contribution is correctly implemented: it reduces gas consumption for the common cases, makes storage improvements, etc. and does not have too much negative impact for the rest of the use-cases +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/compiler-documentation.md b/.github/PULL_REQUEST_TEMPLATE/compiler-documentation.md new file mode 100644 index 000000000..14b0dcfb1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/compiler-documentation.md @@ -0,0 +1,14 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/dependencies.md b/.github/PULL_REQUEST_TEMPLATE/dependencies.md new file mode 100644 index 000000000..90e2ebf9c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/dependencies.md @@ -0,0 +1,15 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/language-feature.md b/.github/PULL_REQUEST_TEMPLATE/language-feature.md new file mode 100644 index 000000000..4bccc1a42 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/language-feature.md @@ -0,0 +1,17 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have documented my contribution in Tact Docs: https://github.com/tact-lang/tact-docs/pull/PR-NUMBER +- [ ] I have added tests to demonstrate the contribution is correctly implemented: this usually includes both positive and negative tests, showing the happy path(s) and featuring intentionally broken cases +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/linters.md b/.github/PULL_REQUEST_TEMPLATE/linters.md new file mode 100644 index 000000000..baffc1cdc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/linters.md @@ -0,0 +1,13 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/PULL_REQUEST_TEMPLATE/policies.md b/.github/PULL_REQUEST_TEMPLATE/policies.md new file mode 100644 index 000000000..8e9c2be5f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/policies.md @@ -0,0 +1,7 @@ +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have run the linter, formatter and spellchecker diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 000000000..9f3843440 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,9 @@ +## Issue + +Towards issue #number. + +## Checklist + +- [ ] I have improved and updated CHANGELOG.md +- [ ] I have updated `package.json` with the new version +- [ ] I have run the linter, formatter and spellchecker diff --git a/.github/PULL_REQUEST_TEMPLATE/tests.md b/.github/PULL_REQUEST_TEMPLATE/tests.md new file mode 100644 index 000000000..90e2ebf9c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/tests.md @@ -0,0 +1,15 @@ + + +## Issue + +Closes issue #number. + +## Checklist + +- [ ] I have updated CHANGELOG.md +- [ ] I have run all the tests locally and no test failure was reported +- [ ] I have run the linter, formatter and spellchecker +- [ ] I did not do unrelated and/or undiscussed refactorings diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8c49479d9..40eecea70 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,15 +1,14 @@ -Closes #number +Click the `Preview` tab and select a PR template: - - -- [ ] I have updated CHANGELOG.md -- [ ] I have documented my contribution in Tact Docs: https://github.com/tact-lang/tact-docs/pull/PR-NUMBER -- [ ] I have added tests to demonstrate the contribution is correctly implemented: this usually includes both positive and negative tests, showing the happy path(s) and featuring intentionally broken cases -- [ ] I have run all the tests locally and no test failure was reported -- [ ] I have run the linter, formatter and spellchecker -- [ ] I did not do unrelated and/or undiscussed refactorings +- [New language feature](?expand=1&template=language-feature.md) +- [Bugfix](?expand=1&template=bugfix.md) +- [Optimization of generated code](?expand=1&template=codegen.md) +- [API for third-party tools](?expand=1&template=api.md) +- [Project dependencies: updating, porting to another library, etc.](?expand=1&template=dependencies.md) +- [CI](?expand=1&template=CI.md) +- [Linters: adding more lints or changing the existing ones](?expand=1&template=linters.md) +- [Compiler documentation](?expand=1&template=compiler-documentation.md) +- [Improve compiler tests by adding new ones or modifying the existing tests](?expand=1&template=tests.md) +- [Tact release](?expand=1&template=release.md) +- [Project policies](?expand=1&template=policies.md) +- [Code quality improvement](?expand=1&code-quality.md)