Add docs and modify PR template

This commit is contained in:
Andrew Morgan 2019-01-28 10:18:26 +00:00
commit f586d50d51
2 changed files with 15 additions and 0 deletions

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,7 @@
### Pull Request Checklist
<!-- Please read CONTRIBUTING.rst before submitting your pull request -->
* [ ] 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)

8
docs/sytest.md Normal file
View file

@ -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.