From fbe2e75e3f51f4e9a6bf044d11fee0dfc4a68c57 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Sun, 19 Aug 2018 14:36:31 +0200 Subject: [PATCH] Fixed markdown style --- .github/CONTRIBUTING.md | 2 ++ .github/ISSUE_TEMPLATE/bug_report.md | 13 +++++++++++-- .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++++--------- docs/en-US/about_JiraPS.md | 3 +++ 4 files changed, 30 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 27aa0d44..250eb3c8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,6 +7,7 @@ We have a comprehensive documentation on how to contribute here: **[Contributing But here is the gist of it once you have forked the repository: * before changing the code + ```powershell git clone https://github.com//JiraPS cd JiraPS @@ -16,6 +17,7 @@ code . ``` * after making the changes + ```powershell git add . git commit -m "" diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 497cc3fe..5fedbbfc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,41 @@ --- name: Bug report about: Create a report to help us improve - --- + + ## Description + ## Steps To Reproduce + + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error ## Expected behavior + ## Screenshots + ## Your Environment + + > ```powershell -> Get-Module JiraPS -ListAvailable | select version +> Get-Module JiraPS -ListAvailable | Select Name, Version > $PSVersionTable > ``` ## Possible Solution + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 066b2d92..444e7b69 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,17 +1,22 @@ --- name: Feature request about: Suggest an idea for this project - --- + + + +## Context + +> **Is your feature request related to a problem? Please describe.** + + + +## Description -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +> **Describe the solution you'd like** -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Additional Information -**Additional context** -Add any other context or screenshots about the feature request here. + diff --git a/docs/en-US/about_JiraPS.md b/docs/en-US/about_JiraPS.md index fabb3d40..9877475e 100644 --- a/docs/en-US/about_JiraPS.md +++ b/docs/en-US/about_JiraPS.md @@ -45,16 +45,19 @@ JiraPS also allows for creating a session with the server with `New-JiraSession` ## DISCOVERING YOUR ENVIRONMENT Finding all projects you have access to: + ```powershell Get-JiraProject ``` Get all issues in a project: + ```powershell Get-JiraIssue -Query "project = CS" ``` See all available information of an issue: + ```powershell Get-JiraIssue "CS-15" | Format-List * ```