Skip to content

clarify style guideline #4463

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

clarify style guideline #4463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ There are 2 build configurations. Besides `Release` there is `Debug`, which *doe

We have an automated test suite in the solution which runs in CI, though you can and should run it before pushing.
There are also [various Analyzers](https://github.com/TASEmulators/BizHawk/wiki/Roslyn-Analyzers-%28third-party%29) (static code analysis plugins) for detecting common mistakes and checking code style. Most of these are enabled by default for the main solution, but you can add `-p:RunStyleCop=true` when building.
In addition, not every style rule is currently enabled, so please make sure you use tabs for indentation and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style), and match the line endings of the file you're editing (but don't try to fix code you're not working on).
In addition, not every style rule is currently enabled, so please make sure you use tabs for indentation and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) (where braces are used), and match the line endings of the file you're editing (but don't try to fix code you're not working on).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In addition, not every style rule is currently enabled, so please make sure you use tabs for indentation and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) (where braces are used), and match the line endings of the file you're editing (but don't try to fix code you're not working on).
In addition, not every style rule is currently enabled, so please make sure you use tabs for indentation and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) (when multiline, else omit braces), and match the line endings of the file you're editing (but don't try to fix code you're not working on).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not want to forbid braces on single-line blocks.


There are additional test suites specifically for regression-testing cores—these are not included in the solution and need to be run manually. See [the base project's readme](src/BizHawk.Tests.Testroms.GB/readme.md) for details.

Expand Down
Loading