adding a styleguide

[Janther]

this is a simplified list from the Solidity Style Guide made to help find the patterns still needed to be implemented.

[codecov]

Codecov Report

Merging #131 into master will decrease coverage by 0.23%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #131      +/-   ##
==========================================
- Coverage   97.21%   96.98%   -0.24%     
==========================================
  Files          66       66              
  Lines         431      431              
  Branches       55       55              
==========================================
- Hits          419      418       -1     
- Misses         12       13       +1

Impacted Files	Coverage Δ
src/clean.js	33.33% <0%> (-66.67%)	⬇️
src/nodes/BreakStatement.js	100% <0%> (+33.33%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7cd752a...ecbb713. Read the comment docs.

[fvictorio]

I don't mind merging this, but doesn't it sort-of duplicates the info in the github issues?

(For the record, I feel bad for saying this because this PR seems like it took some effort 🙁)

[Janther]

hehe the Github issues are just the outcome after having created this PR. The info is duplicated but in the PR we have also the tests ensuring that the style guide is being followed. Once we are fully compliant, I would suggest removing the STYLEGUIDE.md file and have a link to the Style Guide in the Solidity repo. but keep the tests and check from time to time if this document evolves and adapt to it.

[fvictorio]

That makes sense to me!