Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add linting instructions and header image

Browse source
This commit is contained in:
Ben Goldsworthy 2021-02-21 11:08:04 +00:00
parent 09b065b463
commit f465732b32
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,3 +1,5 @@
![footnotes](https://raw.githubusercontent.com/media-competence-institute/footnotes/main/img/footnotes.png)
# footnotes # footnotes
## Description ## 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 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). 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 <file(s)>`)
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 <file(s)>`)
- You can run either across the entire project by adding the argument `--ignore=*/vendor/*` and targetting the file `*/**/*.php`
## Updating Documentation ## Updating Documentation
1. Install [phpDocumentor](https://phpdoc.org/) 1. Install [phpDocumentor](https://phpdoc.org/)
1. Run it (`phpDocumentor -d . -t docs`) 1. Run it (`phpDocumentor -d . -t docs`)
## Testing
Unit tests are TODO.
## Main Features ## Main Features
- Fully customizable **footnotes** start and end shortcodes; - Fully customizable **footnotes** start and end shortcodes;