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

Updated 1.1. Repo. Root (markdown)

Ben Goldsworthy 2021-04-25 16:46:40 +01:00
parent ee52093587
commit 12196fab8a
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
1.1.-Repo.-Root.md

@ -6,4 +6,23 @@
| `docs/` | Automatically-generated documentation files. |
| `src/` | The source code for the Plugin itself. |
| `_tools/` | Useful Bash scripts (@todo this should eventually be merged with `.github/workflows/`). |
| `.github/` | GitHub Actions workflows and Issue templates. |
| `.github/` | GitHub Actions workflows and Issue templates. |
# Repo. Root Files
| 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. |