Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Create a style guideline #27

Open
rheone opened this issue Nov 8, 2019 · 1 comment
Open

[Doc] Create a style guideline #27

rheone opened this issue Nov 8, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rheone
Copy link
Member

rheone commented Nov 8, 2019

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
@rheone rheone added the documentation Improvements or additions to documentation label Nov 8, 2019
@rheone
Copy link
Member Author

rheone commented Nov 8, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant