Skip to content

Commit

Permalink
Add CONTRIBUTING file.
Browse files Browse the repository at this point in the history
Initial description of style, tests, and pull request process.
  • Loading branch information
jbeder committed Apr 8, 2015
1 parent 5c390e8 commit b43db54
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit b43db54

Please sign in to comment.