Skip to content

Commit ac36563

Browse files
committed
Create README.md
1 parent d1a3760 commit ac36563

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# DscResource.Tests
2+
Common meta tests for PowerShell DSC resources repositories.
3+
4+
## Goals
5+
6+
1. Consistency in encoding and indentations.
7+
Consistency is good by itself. But more importent it allow us to:
8+
2. Avoid big diffs with cosmetic changes in Pull Requests.
9+
Cosmetic changes (like formatting) make reviews harder.
10+
If you want to include formatting changes (like replacing `"` by `'`),
11+
please make it a **separate commit**.
12+
Reviewers would have an option to review meanful changes separately from formatting.
13+
14+
## Fixers
15+
16+
We are trying to provide automatic fixers, where it's appropriate.
17+
A fixer corresponds to a particular test.
18+
19+
For example, if `Files encoding` test from [Meta.Tests.ps1](Meta.Tests.ps1) test fails,
20+
you should be able to run `ConvertTo-UTF8` fixer from [MetaFixers.psm1](MetaFixers.psm1).

0 commit comments

Comments
 (0)