From 3d645f82f64d2625da32f2c200f17fba6b5ded3f Mon Sep 17 00:00:00 2001 From: Jim Winstead Date: Mon, 25 Nov 2024 12:55:52 -0800 Subject: [PATCH] Add anchors for sections of contributing.md (#179) Addresses php/web-doc#60 until that changes to use a Markdown engine that automatically creates anchors for headers. --- docs/contributing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index a1c5dd0bc..349c7dd2f 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -6,6 +6,7 @@ or by fixing one by [submitting a pull request](#submit-a-pull-request). As all the repositories are hosted on GitHub, you will need a GitHub account to do either of these. + ## Report a Bug If you have found a bug on any of the PHP documentation pages, @@ -18,6 +19,7 @@ you can file a bug report by doing the following: - add all necessary details to the description textarea - click the "Submit new issue" button to file your bug report + ## Submit a Pull Request There are two ways to make changes to the documentation: @@ -25,6 +27,7 @@ There are two ways to make changes to the documentation: - make [more complex changes](#more-complex-changes--building-the-php-documentation) and validate/build the documentation locally on your computer + ## Minor changes To make trivial changes (typos, shorter wording changes or adding/removing short segments) @@ -45,6 +48,7 @@ The repository will run a few basic checks on the changes (e.g. whether the XML markup is valid, whether trailing whitespaces are stripped, etc.) and your PR is ready to be discussed with and merged by the maintainers. + ## More Complex Changes / Building the PHP documentation To build and view the documentation after making more extensive changes @@ -59,10 +63,12 @@ If you'd like to know more about what each repository is and/or how PHP's documentation is built please refer to the [overview](overview.md). + ### Make changes to the documentation [Make your changes](editing.md) keeping in mind the [style guidelines](style.md). + ### Commit changes and open a PR - commit your changes