You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
## Table of Contents
4
4
5
5
*[PHP_CodeSniffer Wiki](#php_codesniffer-wiki)
6
-
*[How does the wiki get updated ?](#how-does-the-wiki-get-updated-)
6
+
*[How does the Wiki get updated ?](#how-does-the-wiki-get-updated-)
7
7
*[Contributing to the Wiki](#contributing-to-the-wiki)
8
8
*[Guidelines for updating the wiki files](#guidelines-for-updating-the-wiki-files)
9
9
*[Running the pre-processing locally](#running-the-pre-processing-locally)
@@ -20,7 +20,7 @@ For now, the documentation for the PHP_CodeSniffer project is available via the
20
20
21
21
* The source of the Wiki was imported into this repository to maintain the commit history.
22
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)).
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
24
* And then it pushes the resulting updated `.md` files to the upstream Wiki repo.
25
25
26
26
<palign="right"><ahref="#table-of-contents">back to top</a></p>
@@ -37,7 +37,7 @@ If you would like to improve the documentation:
37
37
6. Submit a pull request from your fork to this repository. This process is documented in more detail in the [GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
38
38
7. Please ensure your pull requests passes all automated quality checks.
39
39
8. If you updated anything which will be auto-replaced via the pre-processing:
40
-
* The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the wiki).
40
+
* The GitHub Actions workflow will do a "dry-run" for every PR (pre-process only, no push to the Wiki).
41
41
* Please download the artifact which was created via this dry-run and verify the pre-processing replaced the output in the way you expected.
42
42
43
43
When in doubt, open an issue first to discuss your change proposal.
@@ -48,7 +48,7 @@ When in doubt, open an issue first to discuss your change proposal.
48
48
### Guidelines for Updating the Wiki Files
49
49
50
50
* Small PRs fixing only one thing will be better received than larger PRs fixing a lot of things in one go.
51
-
* Always use fully qualified links. This ensures that the links will work when pages are viewed/edited in this repo, as well as when the pages are viewed from the PHPCS wiki.
51
+
* Always use fully qualified links. This ensures that the links will work when pages are viewed/edited in this repo, as well as when the pages are viewed from the PHPCS Wiki.
52
52
* Add table of contents markers if appropriate.
53
53
The start of a page containing a table of contents should look like this:
54
54
```md
@@ -65,7 +65,7 @@ When in doubt, open an issue first to discuss your change proposal.
65
65
* A marker MUST look like `{{COMMAND-OUTPUT ...}}` with `...` being replacement with a quoted `phpcs` or `phpcbf` command.
66
66
* A marker MUST be at the start of a line.
67
67
* A marker MUST be on a line by itself.
68
-
* Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a wiki file.
68
+
* Commands will be run from the project root directory. Keep this in mind when adding a command replacement marker to a Wiki file.
69
69
* The command replacement will not add markdown code fence syntax, so make sure to do this yourself.
70
70
* If a code sample is needed to generate the desired output, place the code sample in a file in the `build/wiki-code-samples` directory.
71
71
@@ -88,7 +88,7 @@ build/wiki-command-replacer.sh
88
88
89
89
Notes:
90
90
* For the bash script to succeed, the `phpcs` and `phpcbf` commands need to be available in the `PATH` for your OS.
91
-
* The bash script will copy the wiki files to the `_wiki` directory before making any replacements to prevent anyone accidentally committing the processed files.
91
+
* The bash script will copy the Wiki files to the `_wiki` directory before making any replacements to prevent anyone accidentally committing the processed files.
92
92
93
93
The table of contents generation can be tested locally by installing the `doctoc` tool and running this locally like so:
Note that this presumes the command replacer has already run and the files have already been copied to the `_wiki` directory.
102
102
103
-
If you only want to test the TOC generation, make sure you copy the wiki files to the `_wiki` directory before running these commands.
103
+
If you only want to test the TOC generation, make sure you copy the Wiki files to the `_wiki` directory before running these commands.
104
104
105
105
<palign="right"><ahref="#table-of-contents">back to top</a></p>
106
106
@@ -140,7 +140,7 @@ To run the quality checks locally, install the following tooling:
140
140
141
141
Publicly editable Wiki pages for big projects get vandalized pretty often and we don't want to risk this type of vandalism leading to users getting incorrect information.
142
142
143
-
As a secondary reason, there are parts of the wiki (especially the output examples), which were pretty out of date.
144
-
By having the wiki source in this repository, it allows for automating certain updates which would otherwise have to be done manually.
143
+
As a secondary reason, there are parts of the Wiki (especially the output examples), which were pretty out of date.
144
+
By having the Wiki source in this repository, it allows for automating certain updates which would otherwise have to be done manually.
145
145
146
146
<palign="right"><ahref="#table-of-contents">back to top</a></p>
0 commit comments