Skip to content

Commit f6a8878

Browse files
authored
Add project standards section to CONTRIBUTING.md (#196)
Makes explicit what style guides and conventions the project follows, so that contributors can see them in advance rather than discovering them through the review process.
1 parent 57d7e8d commit f6a8878

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,19 @@ All submissions, including submissions by project members, require review. We
2121
use GitHub pull requests for this purpose. Consult
2222
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
2323
information on using pull requests.
24+
25+
## Project Standards
26+
27+
- C++ code should follow
28+
[Google's C++ style guide](https://google.github.io/styleguide/cppguide.html).
29+
- Objective-C code should follow
30+
[Google's Objective-C style guide](http://google.github.io/styleguide/objcguide.html).
31+
- For C++ and Objective-C code, please run `clang-format -style=file` on files
32+
you have changed if possible. If you don't have `clang-format`, don't worry;
33+
a project member can do it prior to submission.
34+
- Dart code should follow the
35+
[Dart style guide](https://www.dartlang.org/guides/language/effective-dart/style)
36+
and use `dartfmt`.
37+
- Build scripts and other tooling should be written it Dart. (Some existing
38+
scripts are `bash` or `.bat` scripts; if you need to make non-trivial changes
39+
to one of those scripts, please convert it to Dart first if possible.)

0 commit comments

Comments
 (0)