Github introduced templates for issues and pull requests a couple months ago [1]. I'm interested in making use of them to address common points in our process where new contributors often miss steps. For example, consider a pull request template that looked like this:

```
Thanks for contributing to Servo! Please add an `X` inside each `[ ]` when the step is complete:
- [ ] `./mach build` does not report any errors
- [ ] `./mach test-tidy` does not report any errors
- [ ] These changes modify existing tests or add new ones, or update expected results in `ini` files OR:
- [ ] These changes do not require tests

Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process.
```

This addresses common themes of:
- contributors not knowing about `./mach test-tidy`
- reviewers r+ing without waiting for TravisCI results
- reviewers r+ing without requiring tests

I'm on the fence about whether we should accept PRs that remove this boilerplate, since it doesn't feel like a significant burden to fill out to me. Thoughts?

Cheers,
Josh


[1] https://github.com/blog/2111-issue-and-pull-request-templates
_______________________________________________
dev-servo mailing list
dev-servo@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-servo

Reply via email to