nullworks/doghook
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme to reflect code guidelines and pr guidelines

Browse Source
This commit is contained in:
F1ssi0N 2018-03-13 16:21:36 +00:00
parent 340a2bf364
commit e21469f7b1
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,4 +1,31 @@
| CircleCI | VSTS |
| -------- | ---- |
| [![CircleCI branch](https://img.shields.io/circleci/token/65513b65cff06cd33ff288f738c951bb7b095191/project/github/josh33901/doghook/master.svg)](https://circleci.com/gh/josh33901/doghook) | [![Visual Studio Team services](https://img.shields.io/vso/build/f1ssi0n/a9fe704a-46e4-44b2-b9ed-1ab56526f533/2.svg)](https://f1ssi0n.visualstudio.com/doghook) |
| [![CircleCI branch](https://img.shields.io/circleci/token/65513b65cff06cd33ff288f738c951bb7b095191/project/github/josh33901/doghook/master.svg)](https://circleci.com/gh/josh33901/doghook) | [![Visual Studio Team services](https://img.shields.io/vso/build/f1ssi0n/a9fe704a-46e4-44b2-b9ed-1ab56526f533/2.svg)](https://f1ssi0n.visualstudio.com/doghook) |
# Doghook
## Making code changes
All code changes need to be made added to a new branch that follows the formula `<username>/<subject>` e.g. `marc3842h/circleci-artifacts`. Once you are done with your code changes make a pull request on github, add @josh33901 or @marc3842h as a reviewer. The pull request will make sure that it compiles on both platforms before it is allowed to be merged into the codebase.
Code should be clang-formatted before a pull request is made (otherwise it is a valid reason to decline a pull request).
## C++ guidelines
* Code should be formatted with the .clang-format in the root of the project (maybe make this a git hook??)
* Use almost always auto:
This means using auto where the type is already observable. Examples are:
```cpp
auto v = *reinterpret_cast<LongAndAnnoyingType **>(vraw);
auto f(int a, int b) {
return a + b;
}
```
For functions that have a seperate declaration and definition do not use auto.
* Types are UpperCamelCase :camel:, whilst everything else is lower_snek_case :snake:. Do not use hungarian notation or `m_` for members or any similar prefix suffix system (`_t` for types).
* We are using C++ which means you dont need to do stupid C style struct typedef tricks. Remove these.
### Copy-pasted code blocks should be updated to match these guidelines to preserve consistency across the codebase!