From 4d0780241256518252df0ecfb90312153cad2dd3 Mon Sep 17 00:00:00 2001 From: Adam Haynes Date: Fri, 17 Aug 2018 10:56:51 +0200 Subject: [PATCH] updated readme --- CONTRIBUTING.md => README.CONTRIBUTING.md | 11 +---------- TestsGuidelines.md => README.TESTGUIDELINES.md | 0 README.md | 2 +- StyleGuidelines.md | 3 --- 4 files changed, 2 insertions(+), 14 deletions(-) rename CONTRIBUTING.md => README.CONTRIBUTING.md (97%) rename TestsGuidelines.md => README.TESTGUIDELINES.md (100%) delete mode 100644 StyleGuidelines.md diff --git a/CONTRIBUTING.md b/README.CONTRIBUTING.md similarity index 97% rename from CONTRIBUTING.md rename to README.CONTRIBUTING.md index 37e70f72d..8fbe9e817 100644 --- a/CONTRIBUTING.md +++ b/README.CONTRIBUTING.md @@ -32,21 +32,12 @@ Submitting an issue to PowerStig is easy! Here are the steps: -1. Find the correct repository to submit your issue to. 1. Make sure the issue is not open already. 1. Open a new issue. 1. Fill in the issue title. 1. Fill in the issue description. 1. Submit the issue. -### Find the Correct Repository - -| Issue Topic | Where to Submit | -|-------------|-----------------| -| PowerStig overall, Issues that span multiple PowerStig projects or repos, PowerStig processes | PowerStig (this repository) | -| Common tests, Schemas | [PowerStig.Tests](https://github.com/Microsoft/PowerStig.Tests) -| Bugs, feature requests, enhancements to a specific module | The repository of the module | - ### Open an Issue Once you are in the correct repository to submit your issue, go to the Issues tab. @@ -159,7 +150,7 @@ If you are making a breaking change, please make sure to read the [Breaking Chan All modules in PowerStig should have tests written using [Pester](https://github.com/pester/Pester) included in the Tests folder. You are required to provide adequate test coverage for the code you change. -Please refer to our [testing guidelines](TestsGuidelines.md) for information on how to write tests for PowerStig. +Please refer to our [testing guidelines](README.TESTGUIDELINES.md) for information on how to write tests for PowerStig. Our test templates and guidelines are currently under construction. Use them with caution as they may be changed soon. diff --git a/TestsGuidelines.md b/README.TESTGUIDELINES.md similarity index 100% rename from TestsGuidelines.md rename to README.TESTGUIDELINES.md diff --git a/README.md b/README.md index 6644602e5..8cf694b7c 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Update-Module -Name PowerStig You are more than welcome to contribute to the development of PowerStig. There are several different ways you can help. You can create new convert modules, add test automation, improve documentation, fix existing issues, or open new ones. -See our [contributing guide](CONTRIBUTING.md) for more info on how to become a contributor. +See our [contributing guide](README.CONTRIBUTING.md) for more info on how to become a contributor. If you would like to contribute to a Composite Resource, please check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md). Thank you to everyone that has reviewed the project and provided feedback through issues. diff --git a/StyleGuidelines.md b/StyleGuidelines.md deleted file mode 100644 index 7c99e698b..000000000 --- a/StyleGuidelines.md +++ /dev/null @@ -1,3 +0,0 @@ -# PowerStig Style Guidelines - -We have adopted the style guidelines from the PowerShell DSC Resource repository. Most of these styles guidelines are enforced with tests that we automatically run from the DscResource.Tests repository. To review the style guidelines, please visit [here](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md).