Skip to content

Commit 971fc61

Browse files
committed
Corrections to notes re: Analyzers/linting in the contribution guide
1 parent f576e32 commit 971fc61

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ To build from the command-line on Unix, run `Dist/BuildRelease.sh`, and then `ou
121121
There are 2 build configurations. Besides `Release` there is `Debug`, which *does not run* bytecode optimisations, *does not remove* debugging symbols, *enables* additional logging and assertions, and *enables* some features. On Windows, a `Debug` executable will spawn a console window for stdout. Note there is also a "stronger" release build in the form of `VersionInfo.DeveloperBuild == false`, which is only used by GitLab CI for preparing a release (during `Dist/UpdateVersionInfoForRelease.sh`).
122122

123123
We have an automated test suite in the solution which runs in CI, though you can and should run it before pushing.
124-
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. These are disabled by default for the main solution; pass `-p:RunAnalyzersDuringBuild=true` to the build script, or set the env. var `MachineRunAnalyzersDuringBuild=1`.
125-
In addition, not every style rule is currently enabled, so please make sure you use CRLF, tabs, and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) (but don't try to fix code you're not working on).
124+
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; pass `-p:RunAnalyzersDuringBuild=true` to the build script, or set the env. var `MachineRunAnalyzersDuringBuild=1`, to lint harder.
125+
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).
126126

127127
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.
128128

0 commit comments

Comments
 (0)