Skip to content

Commit c3ccf3e

Browse files
JonathanHensonkahkeng
authored andcommitted
Added some preliminary contribution guidlines.
1 parent 7f2523e commit c3ccf3e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,25 @@ getObjectRequest.SetResponseStreamFactory([](){ return Aws::New<Aws::FStream>( A
460460
auto getObjectOutcome = s3Client->GetObject(getObjectRequest);
461461
```
462462

463-
463+
###Contributing Back
464+
*Please Do!
465+
466+
#####Guidlines
467+
* Don't make changes to generated clients directly. Make your changes in the generator. Changes to Core, Scripts, and High-Level interfaces are fine directly in the code.
468+
* Do not use non-trivial statics anywhere. This will cause custom memory managers to crash in random places.
469+
* Use 4 spaces for indents and never use tabs.
470+
* No exceptions.... no exceptions. Use the Outcome pattern for returning data if you need to also return an optional error code.
471+
* Always think about platform independence. If this is impossible, put a nice abstraction on top of it and use an abstract factory.
472+
* Use RAII, Aws::New and Aws::Delete should only appear in constructors and destructors.
473+
* Be sure to follow the rule of 5.
474+
* Use the C++ 11 standard where possible.
475+
* Use UpperCamelCase for custom type names and function names. Use m_* for member variables. Don't use statics. If you must, use UpperCammelCase for static variables
476+
* Always be const correct, and be mindful of when you need to support r-values. We don't trust compilers to optimize this uniformly accross builds so please be explicit.
477+
* Namespace names should be UpperCammelCase. Never put a using namespace statement in a header file unless it is scoped by a class. It is fine to use a using namespace statement in a cpp file.
478+
* Use enum class, not enum
479+
* prefer `#pragma once for include guards.
480+
* Forward declare whenever possible.
481+
* Use nullptr instead of NULL.
464482

465483

466484

0 commit comments

Comments
 (0)