sandialabs/Arcus

[Doc] Create a style guideline

rheone opened this issue · 1 comments

Description

We're lacking a style guideline both for the C# code and the Sphinx doc generation.

Impact

It will keep the code clean and concise for all devs

Proposed solutions

  • provide a document with the desired guidelines
  • settle upon a .editorconfig for all file types
  • create appropriate resharper code formatter
  • define linter / formatter rules as appropriate
  • run linter as part of build step

Restrucutred Text headings should use the documented Sphinx and RST syntax guide (0.9.3) hierarchy:

  • # with overline, for parts
  • * with overline, for chapters
  • =, for sections
  • -, for subsections
  • ^, for subsubsections
  • “, for paragraphs