Adding TEMPLATE_README.md to DscResource.Template #440

johlju · 2018-09-03T16:10:03Z

Pull Request (PR) description

Adding TEMPLATE_README.md to DscResource.Template
Cleaning up template files.
Adding information of the Plaster template project.

This Pull Request (PR) fixes the following issues

Fixes HQRM Plaster templates #278

Task list

This PR changes documentation
This PR changes DscResource.Template
This PR changes Tests.Template
- The template version number has been increased appropriately.
- An descriptive entry has been added to the CHANGELOG.md under the
  Tests.Template folder.

This change is

johlju · 2018-09-03T16:11:43Z

Since I don't want to rename the README.md file in the DscResource.Template I added a new file TEMPLATE_README.md which has information about the template. I just added some base information for now.

johlju · 2018-09-03T16:12:13Z

@PlagueHO Could you please review this when you have some time? No hurry.

PlagueHO

Great stuff @johlju - amazing as always. Few bits and pieces - nothing major. I'm traveling for work the next couple of days, but I'll try and get through some reviews while I'm at hotels etc.

Reviewed 4 of 4 files at r1.
Reviewable status: 3 of 4 files reviewed, 24 unresolved discussions (waiting on @PlagueHO and @johlju)

DscResource.Template/TEMPLATE_README.md, line 8 at r1 (raw file):

## Using the template

The template is used by copy all the folder and files under the folder

copy -> copying

DscResource.Template/TEMPLATE_README.md, line 11 at r1 (raw file):

[DscResource.Template](https://github.com/PowerShell/DscResources/tree/master/DscResource.Template)
to the root of your new repository.
After that you need to go through each file, update the information and code.

...go through each file and update the information and code.

DscResource.Template/TEMPLATE_README.md, line 16 at r1 (raw file):

[Adding services to your repository](#adding-services-to-your-repository).

A suggestion is to add a LICENSE and a CONTRIBUTING.md file to your repository.

FYI, Could read -> It is suggested that you add a LICENSE and CONTRIBUTING.md file to your repository as well.

DscResource.Template/TEMPLATE_README.md, line 70 at r1 (raw file):

This is the settings file for the Codecov service. This contains the settings
for the DSC Resource Kit.
No changes is needed for this file.

No changes is -> No changes are

DscResource.Template/TEMPLATE_README.md, line 75 at r1 (raw file):

This is the settings file for git. This file is used by DSC Resource Kit to
always check out the files with CRLF regardless how git is configured.

regardless how -> regardless of how

DscResource.Template/TEMPLATE_README.md, line 78 at r1 (raw file):

It must be present for the automatic publishing of examples to PowerShell Gallery
to work (opt-in in the test framework, DscResource.Tests).
No changes is needed for this file.

No changes is -> No changes are

DscResource.Template/TEMPLATE_README.md, line 82 at r1 (raw file):

#### .gitignore

This file is used by git to ignore certain files or folder so they does not get

files or folder so they does not get -> files or folders so that that they do not get

DscResource.Template/TEMPLATE_README.md, line 84 at r1 (raw file):

This file is used by git to ignore certain files or folder so they does not get
committed to the repository. This file is used by the DSC Resource Kit to ignore
the folder DscResource.Tests which is automatically cloned by the unit and

DscResource.Tests which -> DscResource.Tests, which

DscResource.Template/TEMPLATE_README.md, line 86 at r1 (raw file):

the folder DscResource.Tests which is automatically cloned by the unit and
integration tests when using the unit and integration test templates.
No changes is needed for this file.

No changes is -> No changes are

DscResource.Template/TEMPLATE_README.md, line 90 at r1 (raw file):

#### .MetaTestOptIn.json

This files controls what tests are opt-in when the test framework is run, in for

, in for example AppVeyor -> for example AppVeyor

DscResource.Template/TEMPLATE_README.md, line 92 at r1 (raw file):

This files controls what tests are opt-in when the test framework is run, in for
example AppVeyor.
If some test is opt-out, then the test framework will output the strings to put

is -> are

DscResource.Template/TEMPLATE_README.md, line 94 at r1 (raw file):

If some test is opt-out, then the test framework will output the strings to put
into this file. Add those strings to this file to opt-in for those tests.
No changes is needed for this file, unless opt-in for more tests.

No changes is needed for this file, unless opt-in for more tests. -> No changes are needed for this file, unless opt-in to more tests.

DscResource.Template/TEMPLATE_README.md, line 99 at r1 (raw file):

This is the control file for AppVeyor (that runs the CI pipeline). This file
tells AppVeyor how and what to run.

FYI, Probably obvious, but could say "tells AppVeyor how and what to run during the continuous integration process."

DscResource.Template/TEMPLATE_README.md, line 100 at r1 (raw file):

This is the control file for AppVeyor (that runs the CI pipeline). This file
tells AppVeyor how and what to run.
If using the automatic publishing of examples, then the API key need to be

need -> needs

DscResource.Template/TEMPLATE_README.md, line 102 at r1 (raw file):

If using the automatic publishing of examples, then the API key need to be
updated, otherwise the environment variable can be removed.
No other changes is needed for this file.

No other changes is -> No other changes are

DscResource.Template/TEMPLATE_README.md, line 106 at r1 (raw file):

#### CHANGELOG.md

This file is meant to used to track changes in the resource module. Update

FYI, Could be: This file is used to track changes to the resource module.

DscResource.Template/TEMPLATE_README.md, line 112 at r1 (raw file):

#### README.md

This file is meant to used to show information about the repository and the

FYI, could be: This file is used to show information about the repository...

DscResource.Template/TEMPLATE_README.md, line 119 at r1 (raw file):

- {ModuleName} throughout to match the name of the resource module.
- { Description of the module ... } to match the description of your module.
- Change the section about the code of conduct to one that you want you and your

FYI, could be: Change the 'Code of Conduct' section to one ...

DscResource.Template/TEMPLATE_README.md, line 124 at r1 (raw file):

- Update the section "How to contribute". Can also point to your contributing
  guidelines in a CONTRIBUTING.md.
- Under the section Resources to match your resources.

Under -> Update

DscResource.Template/TEMPLATE_README.md, line 131 at r1 (raw file):

module.
Replace the content of the properties in this file to match your resource module.
Important is to change the GUID in this file to a new unique GUID for your

It is important to change the GUID in this file to a new unique GUID for your module.

DscResource.Template/TEMPLATE_README.md, line 137 at r1 (raw file):

This folder contains settings file for Visual Studio Code. The settings file
is used to simplify formatting and making sue the correct PS Script Analyzer

sue -> sure

DscResource.Template/TEMPLATE_README.md, line 140 at r1 (raw file):

rules are used.
If Visual Studio Code is not used as the editor, then this folder is not
necessary. No changes is needed for the files in this folder.

No changes is -> No changes are

DscResource.Template/TEMPLATE_README.md, line 144 at r1 (raw file):

#### DSCResources

This folder contain the actual resource in this resource module.

contain -> contains, resource -> resource(s)

DscResource.Template/TEMPLATE_README.md, line 149 at r1 (raw file):

This folder is meant to contain PowerShell modules that holds helper functions
used by more than one resource. Using this folder for helper function make sure

function -> functions

DscResource.Template/TEMPLATE_README.md, line 154 at r1 (raw file):

#### Examples

This folder contain the examples of using the resources. These example can

This folder contains the examples of using the resources.

DscResource.Template/TEMPLATE_README.md, line 168 at r1 (raw file):

By separating integration tests from the unit tests, the unit test can be run
without the need to be afraid that a test could potentially make destructive

the need to be afraid -> the fear

DscResource.Template/TEMPLATE_README.md, line 174 at r1 (raw file):

This folder should contain the unit tests. A unit test is a test
that _does not_ make changes to the environment. Instead a unit test mock

Instead a unit test mock -> Instead, a unit test mocks

DscResource.Template/TEMPLATE_README.md, line 180 at r1 (raw file):

By separating integration tests from the unit tests, the unit test can be run
without the need to be afraid that a test could potentially make destructive

the need to be afraid -> the fear

DscResource.Template/TEMPLATE_README.md, line 185 at r1 (raw file):

## Adding services to your repository

The template assume som free services (for open source projects on GitHub) are

assume som -> assumes some

johlju

@PlagueHO Thanks for the proof reading again! 😃

Reviewable status: 3 of 4 files reviewed, 24 unresolved discussions (waiting on @PlagueHO)

DscResource.Template/TEMPLATE_README.md, line 8 at r1 (raw file):