From 2325bde3d87527253987863571f6f4d635012a9c Mon Sep 17 00:00:00 2001
From: Wolfgang Hess <whess@lyft.com>
Date: Wed, 18 Nov 2020 09:54:52 +0100
Subject: [PATCH] Improve CONTRIBUTING.md and add a pull request template.
 (#1564)

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 <whess@lyft.com>
---
 .github/PULL_REQUEST_TEMPLATE.md |  2 ++
 CONTRIBUTING.md                  | 22 +++++++++++++++++++++-
 2 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..bf6c78e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f123a3d..42d2869 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.