Skip to content

Commit

Permalink
chore: prettify some md files
Browse files Browse the repository at this point in the history
  • Loading branch information
tatomyr committed May 30, 2023
1 parent 962bbf9 commit cb530e3
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Hi! We're really excited that you are interested in contributing to Redocly CLI.
- Abide by our [Code of Conduct](https://redocly.com/code-of-conduct/) in all your interactions on this repository, and show patience and respect to other community members.

## Pull Request Guidelines

Before submitting a pull request, please make sure the following is done:

1. Fork the repository and create your branch from `main`.
Expand All @@ -38,7 +39,7 @@ $ npm install # or npm i

### Commonly used NPM scripts

``` bash
```bash
# run a separate CLI command
$ npm run <command>

Expand Down
9 changes: 8 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,41 @@ about: Create a report to help us improve
title: ''
labels: 'Type: Bug'
assignees: ''

---

**Describe the bug**

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

**To Reproduce**
Steps to reproduce the behavior:

1. Given this `redocly.yaml` file
2. And this OpenAPI file(s)
3. Run this command with these arguments... `redocly ...`
4. See error

**Expected behavior**

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

**Logs**

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

**OpenAPI definition**

<!-- If applicable, add an OpenAPI definition and `.redocly.yaml` configuration file that helps reproduce the problem.
At a minimum, please state the specification version(s) you're using (e.g. 2.0, 3.0, 3.1). -->

**Redocly Version(s)**

<!-- What version of Redocly CLI are you using? -->

**`Node.js` Version(s)**

<!-- What version of `node.js` are you using? -->

**Additional context**

<!-- Add any other context about the problem here. -->
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ about: Suggest an idea for this project
title: ''
labels: 'Type: Enhancement'
assignees: ''

---

**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**

<!-- 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 context**

<!-- Add any other context or screenshots about the feature request here. -->
2 changes: 1 addition & 1 deletion __tests__/join/reference-in-description/description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Test description from md file
Test description from md file
2 changes: 1 addition & 1 deletion __tests__/lint/assertions/description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Example description
Example description
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Hello World

Lorem ipsum
Lorem ipsum
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Hello
Hello
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Hello
Hello
2 changes: 1 addition & 1 deletion resources/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Hello World

Test
Test

0 comments on commit cb530e3

Please sign in to comment.