Skip to content

Commit 62be1a6

Browse files
avpfacebook-github-bot
authored andcommitted
Add coding standards
Summary: Add some expectations for external contributions. Original Author: [email protected] Original Git: 869312f Original Reviewed By: avp Original Revision: D46136240 Reviewed By: neildhar Differential Revision: D47690407 fbshipit-source-id: 3e63a25a00e7952b9ec438b055dd846f2f89da6b
1 parent b7e93a5 commit 62be1a6

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Contributing to Hermes
22
We want to make contributing to this project simple and convenient.
33

4+
This document provides a high level overview of the contribution process,
5+
please also review our [Coding Standards](doc/CodingStandards.md).
6+
47
## Code of Conduct
58
Facebook has adopted a Code of Conduct that we expect project participants to
69
adhere to. Please [read the full text](https://code.fb.com/codeofconduct/) so

doc/CodingStandards.md

+12
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ This document provides guidance for the kind of code that should go in to
99
the Hermes project. The rules in this document will allow us to scale the
1010
project and ensure that the code base remains readable and maintainable.
1111

12+
### Code Quality
13+
14+
Code quality standards in Hermes are very strict. While we welcome and
15+
support community contributions, expect scrutiny on changes that do not
16+
meet the following standards:
17+
18+
- Contributions must be well understood and explained in PRs. We cannot accept
19+
and maintain contributions that we don't fully understand.
20+
- Contributions should not use shortcuts or hacks in the name of expediency.
21+
Hermes is a critical piece of infrastructure for many apps and systems, and
22+
such code creates ongoing work for maintainers.
23+
1224
### Language Features
1325

1426
Hermes uses C++14.

0 commit comments

Comments
 (0)