Skip to content

Commit

Permalink
Improve CONTRIBUTING.md and add a pull request template.
Browse files Browse the repository at this point in the history
This is similar to cartographer-project/cartographer#1780, but
- we add a pull request template (there was none before)
- we refer to cartographer_ros CONTRIBUTING.md
- we give different instructions to execute cartographer_ros tests

Signed-off-by: Wolfgang Hess <[email protected]>
  • Loading branch information
wohe committed Nov 17, 2020
1 parent 0b66821 commit cee8b8d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Want to contribute? Great! Make sure you've read and understood
[CONTRIBUTING.md](https://github.com/cartographer-project/cartographer_ros/blob/master/CONTRIBUTING.md).
22 changes: 21 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,25 @@ You can sign-off a commit via `git commit -s`.
### Code reviews

All submissions, including submissions by project members, require review.
We use GitHub pull requests for this purpose.
We use GitHub pull requests for this purpose. Make sure you've read,
understood and considered all the points below before creating your PR.

#### Style guide

C++ code should adhere to the
[Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
You can handle the formatting part of the style guide via `git clang-format`.

#### Best practices

When preparing your PR and also during the code review make sure to follow
[best practices](https://google.github.io/eng-practices/review/developer/).
Most importantly, keep your PR under 200 lines of code and address a single
concern.

#### Testing

- Add unit tests and documentation (these do not count toward your 200 lines).
- Run tests as appropriate, e.g. `docker build . -t cartographer:noetic -f Dockerfile.noetic`.
- Keep rebasing (or merging) of master branch to a minimum. It triggers Travis
runs for every update which blocks merging of other changes.

0 comments on commit cee8b8d

Please sign in to comment.