From 85713d9aa041abb9ce056e05902208c1bb8a5e1b Mon Sep 17 00:00:00 2001 From: Johan Ljunggren Date: Sun, 5 Jul 2020 10:49:23 +0200 Subject: [PATCH 1/3] AzureDevOpsDsc: Adds GitHub templates --- .github/ISSUE_TEMPLATE/General.md | 7 ++ .../ISSUE_TEMPLATE/Problem_with_resource.md | 73 +++++++++++++++++++ .github/ISSUE_TEMPLATE/Resource_proposal.md | 21 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 52 +++++++++++++ CHANGELOG.md | 11 +++ 5 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/General.md create mode 100644 .github/ISSUE_TEMPLATE/Problem_with_resource.md create mode 100644 .github/ISSUE_TEMPLATE/Resource_proposal.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CHANGELOG.md diff --git a/.github/ISSUE_TEMPLATE/General.md b/.github/ISSUE_TEMPLATE/General.md new file mode 100644 index 000000000..fbcdf2405 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/General.md @@ -0,0 +1,7 @@ +--- +name: General question or documentation update +about: If you have a general question or documentation update suggestion around the resource module. +--- + diff --git a/.github/ISSUE_TEMPLATE/Problem_with_resource.md b/.github/ISSUE_TEMPLATE/Problem_with_resource.md new file mode 100644 index 000000000..115745876 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Problem_with_resource.md @@ -0,0 +1,73 @@ +--- +name: Problem with a resource +about: If you have a problem, bug, or enhancement with a resource in this resource module. +--- + +#### Details of the scenario you tried and the problem that is occurring + +#### Verbose logs showing the problem + +#### Suggested solution to the issue + +#### The DSC configuration that is used to reproduce the issue (as detailed as possible) +```powershell +# insert configuration here +``` + +#### SQL Server edition and version the target node is running + + +#### SQL Server PowerShell modules present on the target node + + +#### The operating system the target node is running + + +#### Version and build of PowerShell the target node is running + + +#### Version of the DSC module that was used + diff --git a/.github/ISSUE_TEMPLATE/Resource_proposal.md b/.github/ISSUE_TEMPLATE/Resource_proposal.md new file mode 100644 index 000000000..9f2a069a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Resource_proposal.md @@ -0,0 +1,21 @@ +--- +name: New resource proposal +about: If you have a new resource proposal that you think should be added to this resource module. +--- + +### Description + +### Proposed properties + +### Special considerations or limitations diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..df55b0e7d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,52 @@ + +#### Pull Request (PR) description + + +#### This Pull Request (PR) fixes the following issues + + +#### Task list + +- [ ] Added an entry to the change log under the Unreleased section of the + file CHANGELOG.md. Entry should say what was changed and how that + affects users (if applicable), and reference the issue being resolved + (if applicable). +- [ ] Resource documentation updated in the resource's README.md. +- [ ] Resource parameter descriptions updated in schema.mof. +- [ ] Comment-based help updated, including parameter descriptions. +- [ ] Localization strings updated. +- [ ] Examples updated. +- [ ] Unit tests updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines). +- [ ] Integration tests updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines). +- [ ] Code changes adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines). diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..ee504fec3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Change log for AzureDevOpsDsc + +The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- AzureDevOpsDsc + - Added GitHub issue templates and pull request template ([issue #1](https://github.com/dsccommunity/AzureDevOpsDsc/issues/1)) From 0dabcfeed00d75c633891ede5ac44a500c8d3d73 Mon Sep 17 00:00:00 2001 From: Johan Ljunggren Date: Tue, 7 Jul 2020 09:10:35 +0200 Subject: [PATCH 2/3] Update .github/ISSUE_TEMPLATE/Problem_with_resource.md Co-authored-by: Ryan Yates --- .github/ISSUE_TEMPLATE/Problem_with_resource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/Problem_with_resource.md b/.github/ISSUE_TEMPLATE/Problem_with_resource.md index 115745876..a8dd468fd 100644 --- a/.github/ISSUE_TEMPLATE/Problem_with_resource.md +++ b/.github/ISSUE_TEMPLATE/Problem_with_resource.md @@ -69,5 +69,5 @@ about: If you have a problem, bug, or enhancement with a resource in this resour #### Version of the DSC module that was used From 1f23764db2de9ac82590a42615664a9dcb1ccd15 Mon Sep 17 00:00:00 2001 From: Johan Ljunggren Date: Tue, 7 Jul 2020 09:12:14 +0200 Subject: [PATCH 3/3] Fix review comments at r1 --- .github/ISSUE_TEMPLATE/Problem_with_resource.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Problem_with_resource.md b/.github/ISSUE_TEMPLATE/Problem_with_resource.md index a8dd468fd..f7e3d9a48 100644 --- a/.github/ISSUE_TEMPLATE/Problem_with_resource.md +++ b/.github/ISSUE_TEMPLATE/Problem_with_resource.md @@ -32,16 +32,12 @@ about: If you have a problem, bug, or enhancement with a resource in this resour # insert configuration here ``` -#### SQL Server edition and version the target node is running - +#### Azure DevOps Server version the target node is running -#### SQL Server PowerShell modules present on the target node +#### VSTeam PowerShell modules present on the target node #### The operating system the target node is running