From 12196fab8a3f5f4ec6690197604468e80c6d5e76 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 25 Apr 2021 16:46:40 +0100 Subject: [PATCH] Updated 1.1. Repo. Root (markdown) --- 1.1.-Repo.-Root.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/1.1.-Repo.-Root.md b/1.1.-Repo.-Root.md index e189a9a..099f686 100644 --- a/1.1.-Repo.-Root.md +++ b/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. | \ No newline at end of file +| `.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. | \ No newline at end of file