fix: markdown inconsistencies (#71)

asdf-vm · Jun 5, 2023 · 26b4c7b · 26b4c7b
1 parent 51054b8
commit 26b4c7b
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # asdf-plugin-template [![Build](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/build.yml) [![Lint](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml/badge.svg)](https://github.com/asdf-vm/asdf-plugin-template/actions/workflows/lint.yml)
 
 This is an [asdf-vm plugin](https://asdf-vm.com/#/plugins-create) template with CI to run [Shellcheck](https://github.com/koalaman/shellcheck) and testing with the [asdf test GitHub Action](https://github.com/asdf-vm/actions).
+
 ## Usage
 
 1. [Generate](https://github.com/asdf-vm/asdf-plugin-template/generate) a new repository based on this template.
@@ -16,15 +17,20 @@ This is an [asdf-vm plugin](https://asdf-vm.com/#/plugins-create) template with
 Contributions welcome!
 
 1. Install `asdf` tools
+
     ```shell
     asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git
     asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git
     asdf install
     ```
+
 1. Develop!
+
 1. Lint & Format
+
     ```shell
     ./scripts/format.bash
     ./scripts/lint.bash
     ```
+
 1. PR changes
diff --git a/template/.github/PULL_REQUEST/pull_request_template.md b/template/.github/PULL_REQUEST/pull_request_template.md
@@ -25,7 +25,7 @@
 
 <!--- Please describe in detail how you tested your changes. -->
 
-## Checklist:
+## Checklist
 
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

diff --git a/template/.gitlab/merge_request_templates/Merge_Request.md b/template/.gitlab/merge_request_templates/Merge_Request.md
@@ -25,7 +25,7 @@
 
 <!--- Please describe in detail how you tested your changes. -->
 
-## Checklist:
+## Checklist
 
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

diff --git a/template/README-github.md b/template/README-github.md
@@ -2,7 +2,6 @@
 
 # asdf-<YOUR TOOL> [![Build](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/build.yml/badge.svg)](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/build.yml) [![Lint](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/lint.yml/badge.svg)](https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>/actions/workflows/lint.yml)
 
-
 [<YOUR TOOL>](<TOOL HOMEPAGE>) plugin for the [asdf version manager](https://asdf-vm.com).
 
 </div>

diff --git a/template/contributing-github.md b/template/contributing-github.md
@@ -5,7 +5,7 @@ Testing Locally:
 ```shell
 asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]
 
-#
+# TODO: adapt this
 asdf plugin test <YOUR TOOL> https://github.com/<YOUR GITHUB USERNAME>/asdf-<YOUR TOOL>.git "<TOOL CHECK>"
 ```
 

diff --git a/template/contributing-gitlab.md b/template/contributing-gitlab.md
@@ -5,7 +5,7 @@ Testing Locally:
 ```shell
 asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]
 
-#
+# TODO: adapt this
 asdf plugin test <YOUR TOOL> https://gitlab.com/<YOUR GITLAB USERNAME>/asdf-<YOUR TOOL>.git "<TOOL CHECK>"
 ```