diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..4d6769198 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +### Pull Request Checklist + + + +* [ ] I have added any new tests that need to pass to `testfile` as specified in [docs/sytest.md](https://github.com/matrix-org/dendrite/blob/master/docs/sytest.md) +* [ ] I have made sure any new dependencies have been checked into the `vendor/` directory +* [ ] Pull request includes a [sign off](https://github.com/matrix-org/dendrite/blob/master/CONTRIBUTING.md#sign-off) diff --git a/docs/sytest.md b/docs/sytest.md new file mode 100644 index 000000000..a0f7d85c1 --- /dev/null +++ b/docs/sytest.md @@ -0,0 +1,8 @@ +# SyTest + +Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its +integration testing. When creating a new PR, add the test IDs that your PR +should allow to pass to `testfile` in dendrite's root directory. Not all PRs +need to make new tests pass. If we find your PR should be making a test pass we +may ask you to add to that file, as generally Dendrite's progress can be +tracked through the amount of SyTest tests it passes.