From f465732b328471dbabca6fa88bcaa9ec378dc983 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 21 Feb 2021 11:08:04 +0000 Subject: [PATCH] Add linting instructions and header image --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d57f0f6..6bd1e8d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![footnotes](https://raw.githubusercontent.com/media-competence-institute/footnotes/main/img/footnotes.png) + # footnotes ## Description @@ -18,11 +20,21 @@ Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wor 1. When you're finished, commit your changes to the remote version of your branch and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls). +## Checking WP Coding Standard Compliance + +1. Run PHP_CodeSniffer on the file(s) you want to check (`./vendor/bin/phpcs --standard="WordPress" --colors --encoding=utf-8 -n -p `) +1. (If applicable) run the PHP Code Beautifier and Formatter to attempt to automatically fix any errors (`./vendor/bin/phpcbf --standard="WordPress" --encoding=utf-8 -n -p `) + - You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `*/**/*.php` + ## Updating Documentation 1. Install [phpDocumentor](https://phpdoc.org/) 1. Run it (`phpDocumentor -d . -t docs`) +## Testing + +Unit tests are TODO. + ## Main Features - Fully customizable **footnotes** start and end shortcodes;