Skip to content

Add project standards section to CONTRIBUTING.md #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 3, 2019
Merged

Add project standards section to CONTRIBUTING.md #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,19 @@ All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Project Standards

- C++ code should follow
[Google's C++ style guide](https://google.github.io/styleguide/cppguide.html).
- Objective-C code should follow
[Google's Objective-C style guide](http://google.github.io/styleguide/objcguide.html).
- For C++ and Objective-C code, please run `clang-format -style=file` on files
you have changed if possible. If you don't have `clang-format`, don't worry;
a project member can do it prior to submission.
- Dart code should follow the
[Dart style guide](https://www.dartlang.org/guides/language/effective-dart/style)
and use `dartfmt`.
- Build scripts and other tooling should be written it Dart. (Some existing
scripts are `bash` or `.bat` scripts; if you need to make non-trivial changes
to one of those scripts, please convert it to Dart first if possible.)