Document the code styling

finos / datahelix

The DataHelix generator allows you to quickly create data, based on a JSON profile that defines fields and the relationships between them, for the purpose of testing and validation

https://finos.github.io/datahelix/

Apache License 2.0

141 stars 50 forks source link

Document the code styling #1692

Open matthewdunsdon opened 4 years ago

matthewdunsdon commented 4 years ago

Feature request

As a contributor, I would like to know the code styling rules upfront, so that I am aware of them before before committing code.

I am using intellij, so maybe committing .idea/codeStyles would also be helpful.

For completeness, the coding styles were referenced here, but have since been removed. 6456242#diff-8cc7b2b0d78dd2501610391c086a8516 By @sl-slaing in https://github.com/finos/datahelix/pull/1688#issuecomment-660498611

tjohnson-scottlogic commented 4 years ago

Info from @afroggattsl:

The team previously just used the default IntelliJ styling rules, so committing them is the way to go. The developer guide should be updated to mention this.