Skip to content

Add formatting guidelines with PR validation #835

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

Closed
bart-degreed opened this issue Sep 21, 2020 · 1 comment · Fixed by #962
Closed

Add formatting guidelines with PR validation #835

bart-degreed opened this issue Sep 21, 2020 · 1 comment · Fixed by #962
Assignees

Comments

@bart-degreed
Copy link
Contributor

bart-degreed commented Sep 21, 2020

The goal is to define a coding style for this repository, reformat all existing code in this repository and add style validation that runs during PR build.

Steps:

  • Add configuration for Resharper/Rider formatting engine
  • Add JetBrains free cmdline runners (to use for local development and cibuild)
  • Two-phase verification: run InspectCode to flag rule violations, then run CleanupCode and verify it does not add changes

Note this does not include writing up a document that details exactly how code should be formatted. That is a lot of work and error prone. Instead, we'll let the engine decide and reconfigure it when needed. It usually provides good feedback on what needs to change.

@bart-degreed
Copy link
Contributor Author

Should consider to enable nullable reference types in the codebase, as part of this effort.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

1 participant