Skip to content

Commit a5c5c77

Browse files
authored
Update CONTRIBUTING.md
1 parent 564a6b6 commit a5c5c77

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Here are some tips.
66
* Before starting a large pull request, log an issue and outline the problem and a broad outline of your solution. The maintainers will discuss the issue with you and possibly propose some alternative approaches to align with the ClosedXML development conventions.
77
* Please submit pull requests that are based on the `develop` branch.
88
* Where possible, pull requests should include unit tests that cover as many uses cases as possible.
9-
* We recommend Visual Studio 2017 or higher as the development environment. If you do use Visual Studio, please install these extensions:
10-
* [NUnit 3.0 Test Adapter](https://marketplace.visualstudio.com/items?itemName=NUnitDevelopers.NUnit3TestAdapter), for running the unit tests in Visual Studio. More information about this at the [NUnit Adapter Installation](https://github.com/nunit/docs/wiki/Adapter-Installation).
9+
* We recommend Visual Studio 2019 or higher as the development environment. If you do use Visual Studio, please install these extensions:
1110
* [CodeMaid](https://marketplace.visualstudio.com/items?itemName=SteveCadwallader.CodeMaid), for ensuring consistent code syntax, whitespace convention, etc.
1211
* If you use a version of Visual Studio lower than 2017, you should install [editorconfig](<https://marketplace.visualstudio.com/items?itemName=EditorConfigTeam.EditorConfig>) support. Read more about [EditorConfig](http://www.editorconfig.org).
1312
* We use 4 spaces for code indentation. This is the default in Visual Studio. Don't leave any trailing white space at the end of lines or files.
@@ -45,4 +44,4 @@ ClosedXML has a fairly large codebase and we therefore want to keep code revisio
4544
To ensure you follow the coding conventions, please do the following steps before you commit your code:
4645

4746
- In Visual Studio, run `CodeMaid > Cleanup Active Document` or `Ctrl+M, Space` on each file that you have altered. This will ensure the correct whitespace consistency.
48-
- Some files, not all, have a header in the first line: `// Keep this file CodeMaid organised and cleaned`. For these files, also run `CodeMaid > Reorganize Active Document` or `Ctrl+M, Z`. This will reorder properties and methods alphabetically into a predetermined order. For example, public properties and methods will be organized before private properties and methods. Not all files require this yet. Please take note of the headers.
47+
- Some files, not all, have a header in the first line: `// Keep this file CodeMaid organised and cleaned`. For these files, also run `CodeMaid > Reorganize Active Document` or `Ctrl+M, Z`. This will reorder properties and methods alphabetically into a predetermined order. For example, public properties and methods will be organized before private properties and methods. Not all files require this yet. Please take note of the headers.

0 commit comments

Comments
 (0)