From 172dd00b335e5bc6b8cf711c5333bc298cda1702 Mon Sep 17 00:00:00 2001 From: Joe Block Date: Sat, 25 Sep 2021 10:29:36 -0600 Subject: [PATCH 1/2] Add badges and TOC to readme Signed-off-by: Joe Block --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index d2c5754..953c2cc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ # lima-xbar-plugin +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +![Awesomebot](https://github.com/unixorn/lima-xbar-plugin/actions/workflows/awesomebot.yml/badge.svg) +![Superlinter](https://github.com/unixorn/lima-xbar-plugin/actions/workflows/superlinter.yml/badge.svg) +[![GitHub stars](https://img.shields.io/github/stars/unixorn/lima-xbar-plugin.svg)](https://github.com/unixorn/lima-xbar-plugin/stargazers) + + + + +## Table of Contents + +- [Description](#description) +- [Installation](#installation) + - [Dependencies](#dependencies) + + + + [Lima](https://github.com/lima-vm/lima) is an alternative to using Docker Desktop on your Mac. ## Description From 57b64aea8762771ea73a04195fa3d37901fda13a Mon Sep 17 00:00:00 2001 From: Joe Block Date: Sat, 25 Sep 2021 10:32:09 -0600 Subject: [PATCH 2/2] Update wording in PR template Signed-off-by: Joe Block --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 39e9fdc..05b9a19 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,9 +12,9 @@ - [ ] All new and existing tests pass. -- [ ] Any scripts added use `#!/usr/bin/env interpreter` instead of potentially platform-specific direct paths (`#!/bin/sh` and `#!/bin/bash` are allowed exceptions) -- [ ] Scripts are marked executable -- [ ] Scripts _do not_ have a language file extension unless they are meant to be sourced and not run standalone. No one should have to know if a script was written in bash, python, ruby or whatever. Not including file extensions makes it easier to rewrite the script in another language later without having to change every reference to the previous version. +- [ ] Any added/updated scripts added use `#!/usr/bin/env interpreter` instead of potentially platform-specific direct paths (`#!/bin/sh` and `#!/bin/bash` are allowed exceptions) +- [ ] Added/updated scripts are marked executable +- [ ] Scripts _do not_ have a language file extension unless they are meant to be sourced and not run standalone. No end-user should have to know if a script was written in `bash`, `python`, `ruby` or whatever. Not including file extensions makes it easier to rewrite the script in another language later without having to change every reference to the previous version. - [ ] I have confirmed that the link(s) in my PR are valid. # License Acceptance