Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AzureDevOpsDsc: Adds GitHub templates #2

Merged
merged 3 commits into from
Jul 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/General.md
Original file line number Diff line number Diff line change
@@ -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.
---
<!--
Your feedback and support is greatly appreciated, thanks for contributing!
-->
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/Problem_with_resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
name: Problem with a resource
about: If you have a problem, bug, or enhancement with a resource in this resource module.
---
<!--
Your feedback and support is greatly appreciated, thanks for contributing!

ISSUE TITLE:
Please prefix the issue title with the resource name, e.g.
'ResourceName: Short description of my issue'

ISSUE DESCRIPTION (this template):
Please provide information regarding your issue under each header below.
Write N/A under any headers that do not apply to your issue, or if the
information is not available.

NOTE! Sensitive information should be obfuscated.

PLEASE KEEP THE HEADERS.

You may remove this comment block, and the other comment blocks,
but please keep the headers.
-->
#### 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
```

#### Azure DevOps Server version the target node is running

#### VSTeam PowerShell modules present on the target node
<!--
To help with this information, please run this command:
Get-Module -Name 'VSTeam' -ListAvailable | ft Name,Version,Path
-->

#### The operating system the target node is running
<!--
Please provide as much as possible about the target node, for example
edition, version, build and language.
On OS with WMF 5.1 the following command can help get this information.

Get-ComputerInfo -Property @(
'OsName',
'OsOperatingSystemSKU',
'OSArchitecture',
'WindowsVersion',
'WindowsBuildLabEx',
'OsLanguage',
'OsMuiLanguages')
-->

#### Version and build of PowerShell the target node is running
<!--
To help with this information, please run this command:
$PSVersionTable
-->

#### Version of the DSC module that was used
<!--
To help with this information, please run this command:
Get-Module -Name 'AzureDevOpsDSC' -ListAvailable | ft Name,Version,Path
-->
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/Resource_proposal.md
Original file line number Diff line number Diff line change
@@ -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.
---
<!--
Thank you for contributing and making this resource module better!

ISSUE TITLE:
Please prefix the issue title with a proposed resource name,
e.g. 'NewResourceName: New resource proposal'

ISSUE DESCRIPTION (this template):
Please propose the new resource under each header below.

PLEASE KEEP THE HEADERS, but you may remove this comment block.
-->
### Description

### Proposed properties

### Special considerations or limitations
52 changes: 52 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!--
Thanks for submitting a Pull Request (PR) to this project.
Your contribution to this project is greatly appreciated!

Please prefix the PR title with the resource name,
e.g. 'ResourceName: My short description'.
If this is a breaking change, then also prefix the PR title
with 'BREAKING CHANGE:',
e.g. 'BREAKING CHANGE: ResourceName: My short description'.

You may remove this comment block, and the other comment blocks, but please
keep the headers and the task list.
-->
#### Pull Request (PR) description
<!--
Replace this comment block with a description of your PR.
Also, make sure you have updated the CHANGELOG.md, see the
task list below. An entry in the CHANGELOG.md is mandatory
for all PRs.
-->

#### This Pull Request (PR) fixes the following issues
<!--
If this PR does not fix an open issue, replace this comment block with None.
If this PR resolves one or more open issues, replace this comment block with
a list of the issues using a GitHub closing keyword, e.g.:

- Fixes #123
- Fixes #124
-->

#### Task list
<!--
To aid community reviewers in reviewing and merging your PR, please take
the time to run through the below checklist and make sure your PR has
everything updated as required.

Change to [x] for each task in the task list that applies to your PR.
For those task that don't apply to you PR, leave those unchecked.
-->
- [ ] 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).
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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))