From b43db54810846ec0e150d9d04c5b47c5cd9e8029 Mon Sep 17 00:00:00 2001 From: Jesse Beder Date: Wed, 8 Apr 2015 14:30:07 -0500 Subject: [PATCH] Add CONTRIBUTING file. Initial description of style, tests, and pull request process. --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..41f50dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Style + +This project is formatted with [clang-format][fmt] using the style file at the root of the repository. Please run clang-format before sending a pull request. + +In general, try to follow the style of surrounding code. + +[fmt]: http://clang.llvm.org/docs/ClangFormat.html + +# Tests + +Please verify the tests pass by running the target `tests/run_tests`. + +If you are adding functionality, add tests accordingly. + +# Pull request process + +Every pull request undergoes a code review. Unfortunately, github's code review process isn't great, but we'll manage. During the code review, if you make changes, add new commits to the pull request for each change. Once the code review is complete, rebase against the master branch and squash into a single commit.