Skip to content

Commit 2fbff43

Browse files
committed
Fixing up issues with contrib guides and templates
1 parent cf8f224 commit 2fbff43

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

.github/ISSUE_TEMPLATE/Feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
1111
A clear and concise description of what you want to happen.
1212

1313
**Examples of how the solution would work**
14-
Some simple PowerShell examples of how the solution would work.
14+
Some simple examples of how the solution would work.
1515

1616
**Describe alternatives you've considered**
1717
A clear and concise description of any alternative solutions or features you've considered.

contributing.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ The reality is that code will contain bugs, even with thorough testing, issues c
2424
2525
### Before you file a bug report
2626

27-
* **Ensure you are running the latest version of the module.** If you are running an older version of the module, try updating the module and testing if the issue remains. If you installed the module from the [PowerShell Gallery](https://powershellgallery.com), use this command to update the module: ``` PS> Update-Module -Name Posh-SYSLOG ```.
28-
* **Ensure that you are using the CMDLet correctly.** Have you checked the help? Sometimes we assume we know how a specific function or CMDLet works, and it turns out we are wrong. The command ```Get-Help``` is your friend!
2927
* **Has the issue been reported before?** You might not be the only person who has reported the issue. Check out the [Issues][Issues] and look through any current Issues that may match the issue you are experiencing.
3028

3129
### Submitting a (good) bug report
@@ -37,7 +35,7 @@ Here are some tips on ensuring you create an excellent bug report:
3735
* **Bugs should be actionable**, that is, something that can be fixed as part of this project. Issues with Windows, .Net or PowerShell might not be solvable within this project.
3836
* **Use a clear descriptive title** for the issue that describes the issue.
3937
* **Describe the exact steps to reproduce the issue** and include as many details as possible. People often leave things out as they think they might not be important, but every little detail counts! When listing what steps or commands you executed, **don't just say what you did, try to explain how you did it**. Be as detailed as possible, it is safe to say that more is usually better.
40-
* **Provide specific examples**, include specific steps you have taken, link to files or other copy/pastable snippets. If you are providing snippets of code, ensure you use Markdown Code Blocks. <>TODO: link<> If you can, provide the exact steps/code you were executing when the issue happened.
38+
* **Provide specific examples**, include specific steps you have taken, link to files or other copy/pastable snippets. If you are providing snippets of code, ensure you use Markdown Code Blocks. If you can, provide the exact steps/code you were executing when the issue happened.
4139
* **PowerShell Transcripts can be extremely useful** so please include those where possible. You can start a transcript with ```Start-Transcript``` and end it with ```Stop-Transcript```.
4240
* **Screenshots and Gifs** can also be extemely useful, however transcripts are preferred.
4341
* **If there is private/confidential information**, feel free to remove that from any logs/transcripts/images, but remember to highlight where you have done so.
@@ -54,8 +52,6 @@ Got a killer idea for a new feature? Maybe you want to suggest a minor improveme
5452

5553
### Before you submit an enhancement suggestion
5654

57-
* **Ensure you are running the latest version of the module.** The feature you require might be included in a new version of the module. If you installed the module from the Gallery, use this command to update the module: ``` PS> Update-Module -Name Posh-SYSLOG ```.
58-
* **Ensure that you are using the CMDLet correctly.** Have you checked the help? Perhaps the feature has already been implemented but you just haven't discovered it yet! The command ```Get-Help``` is your friend!
5955
* **Has the feature been requested before?** You might not be the only person who has requested this new feature. If it has, add a comment to the existing issue instead of opening a new one. Be sure to checkout closed issues as well, the feature may have been previously implemented or rejected.
6056

6157
### Submitting a (good) enhancement suggestion

0 commit comments

Comments
 (0)