Skip to content

Commit

Permalink
Fixed markdown style
Browse files Browse the repository at this point in the history
  • Loading branch information
lipkau committed Aug 19, 2018
1 parent 77190c0 commit fbe2e75
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<YOUR GITHUB USER>/JiraPS
cd JiraPS
Expand All @@ -16,6 +17,7 @@ code .
```

* after making the changes

```powershell
git add .
git commit -m "<A MESSAGE ABOUT THE CHANGES>"
Expand Down
13 changes: 11 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,41 @@
---
name: Bug report
about: Create a report to help us improve

---
<!-- markdownlint-disable MD002 -->
<!-- markdownlint-disable MD041 -->

## Description

<!-- A clear and concise description of what the bug is. -->

## Steps To Reproduce

<!-- Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

## Your Environment

<!-- Include as many relevant details about the environment you experienced the bug in -->
<!-- The following code snip is a recommendation. You can just paste the output here. -->

> ```powershell
> Get-Module JiraPS -ListAvailable | select version
> Get-Module JiraPS -ListAvailable | Select Name, Version
> $PSVersionTable
> ```
## Possible Solution
<!-- Not obligatory, but suggest a fix/reason for the bug -->
23 changes: 14 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project

---
<!-- markdownlint-disable MD002 -->
<!-- markdownlint-disable MD041 -->

## Context

> **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 [...] -->

## 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.
<!-- 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.
<!-- Add any other context or screenshots about the feature request here. -->
3 changes: 3 additions & 0 deletions docs/en-US/about_JiraPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 *
```
Expand Down

0 comments on commit fbe2e75

Please sign in to comment.