forked from jbeder/yaml-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial description of style, tests, and pull request process.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |