Skip to content

Commit 8d79d73

Browse files
jrfnlafilina
andauthored
[SQUASH-ME] Update CONTRIBUTING.md
Co-authored-by: Anna Filina <[email protected]>
1 parent dd4606e commit 8d79d73

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,9 @@ For now, the documentation for the PHP_CodeSniffer project is available via the
1919
### How does the wiki get updated ?
2020

2121
* The source of the Wiki was imported into this repository to maintain the commit history.
22-
* A [GitHub Actions workflow](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/.github/workflows/publish-wiki.yml) was added to automatically push changes made in the Wiki files in this repository to the upstream Wiki repo.
23-
* Prior to pushing the changes, the workflow will pre-process the files and make the following changes:
24-
* Replace `{{COMMAND-OUTPUT ...}}` command-line output placeholders with actual command-line output from either `phpcs` or `phpcbf`.
25-
The code samples used for generating some of this output can be found in the `build/wiki/code-samples` directory.
26-
* Replace `<!-- START doctoc --> <!-- END doctoc -->` placeholders with a Table of Contents for the page in Markdown.
27-
* Add a prominent (hidden) warning at the top of each wiki file to warn people against editing the wiki files via the GitHub wiki editing interface.
22+
* A [GitHub Actions workflow](https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation/blob/main/.github/workflows/publish-wiki.yml) was added:
23+
* It pre-processes the `.md` files to replace placeholders and inject some other content (see [Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)).
24+
* And then it pushes the resulting updated `.md` files to the upstream Wiki repo.
2825

2926
<p align="right"><a href="#table-of-contents">back to top</a></p>
3027

0 commit comments

Comments
 (0)