osrm-backend/.github/PULL_REQUEST_TEMPLATE.md

31 lines
1.4 KiB
Markdown
Raw Normal View History

2016-08-19 06:28:24 -04:00
# Issue
What issue is this PR targeting? If there is no issue that addresses the problem, please open a corresponding issue and link it here.
2016-08-19 06:28:24 -04:00
## Tasklist
- [ ] ADD OWN TASKS HERE
- [ ] update relevant [Wiki pages](https://github.com/Project-OSRM/osrm-backend/wiki)
2016-08-19 06:28:24 -04:00
- [ ] add regression / cucumber cases (see docs/testing.md)
- [ ] review
- [ ] adjust for comments
2016-08-19 06:28:24 -04:00
## Code Review Checklist - author check these when done, reviewer verify
- [ ] Code formatted with `scripts/format.sh`
- [ ] Changes have test coverage
- [ ] New exceptions, logging, errors - are messages distinct enough to track down in the code if they get thrown in production on non-debug builds?
- [ ] The PR is one logically integrated piece of work. If there are unrelated changes, are they at least separate commits?
- [ ] Commit messages - are they clear enough to understand the intent of the change if we have to look at them later?
- [ ] Code comments - are there comments explaining the intent?
- [ ] Relevant docs updated
- [ ] Changelog entry if required
- [ ] Impact on the API surface
- [ ] If HTTP/libosrm.o is backward compatible features, bump the minor version
- [ ] File format changes require at minor release
- [ ] If old clients can't use the API after changes, bump the major version
If something doesn't apply, please ~~cross it out~~
2016-08-19 06:28:24 -04:00
## Requirements / Relations
Link any requirements here. Other pull requests this PR is based on?