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

Updated 1.2. Root Files (markdown)

Ben Goldsworthy 2021-04-25 16:47:26 +01:00
parent 12196fab8a
commit 8ab6abaac2
2 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
1.2.-Plugin-Source-(`src-`).md Normal file

@ -0,0 +1,19 @@
# Plugin Source Root Files
| File Name | Description |
|------|-------------|
| `footnotes.php` | The Plugin entry point. |
| `includes.php` | Includes all of the PHP files. |
| `license.txt` | The license under which the Plugin is released. |
| `readme.txt` | The Plugin readme for display on the WordPress Plugin Directory. |
# Plugin Source Root Directories
| Dir. Name | Description |
|------|-------------|
| `class/` | Contains the Plugin PHP code, providing most of its functionality. |
| `css/` | Contains the Plugin stylesheets. |
| `img/` | Contains images used by the Plugin (@todo can this be merged with the root `assets/` dir?). |
| `js/` | Contains JavaScript files used by the Plugin. |
| `languages/` | Contains Plugin translation files for various languages. |
| `templates/` | Contains HTML template files used by the Plugin to render various page elements. |

16
1.2.-Root-Files.md

@ -1,16 +0,0 @@
| File Name | Description |
|------|-------------|
| `CHANGELOG.md` | The full project changelog. |
| `CODE_OF_CONDUCT.md` | The project CoC. |
| `composer.json` & `composer.lock` | Declares Composer dependencies and scripts. |
| `CONTRIBUTING.md` | A guide to contributing to the project. |
| `LICENSE` | The license under which the project is released. |
| `package.json` & `package-lock.json` | Declares NPM dependencies and scripts. |
| `README.md` | Provides an overview of the project. |
| `SECURITY.md` | Provides guidance on reporting security-related issues. |
| `wpml-config.xml` | Used by the [WPML Plugin](https://wpml.org/documentation/support/language-configuration-files/) for translation. |
| `.distignore` | Lists files to ignore when building the Plugin for distribution (@todo this is not currently used). |
| `.eslintignore` & `.eslintrc.js` | Config. files for JavaScript linting. |
| `.gitignore` | Lists files to exclude from Git version control. |
| `.prettierignore` & `.prettierrc` | Config. files for JavaScript formatting. |
| `.stylelintignore` & `.stylelinttc.json` | Config. files for stylesheet linting. |