@@ -6,6 +6,7 @@ or by fixing one by [submitting a pull request](#submit-a-pull-request).
6
6
As all the repositories are hosted on GitHub,
7
7
you will need a GitHub account to do either of these.
8
8
9
+ <a name =" report-a-bug " ></a >
9
10
## Report a Bug
10
11
11
12
If you have found a bug on any of the PHP documentation pages,
@@ -18,13 +19,15 @@ you can file a bug report by doing the following:
18
19
- add all necessary details to the description textarea
19
20
- click the "Submit new issue" button to file your bug report
20
21
22
+ <a name =" submit-a-pull-request " ></a >
21
23
## Submit a Pull Request
22
24
23
25
There are two ways to make changes to the documentation:
24
26
- make [ minor changes] ( #minor-changes ) by editing files on GitHub
25
27
- make [ more complex changes] ( #more-complex-changes--building-the-php-documentation )
26
28
and validate/build the documentation locally on your computer
27
29
30
+ <a name =" minor-changes " ></a >
28
31
## Minor changes
29
32
30
33
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
45
48
(e.g. whether the XML markup is valid, whether trailing whitespaces are stripped, etc.)
46
49
and your PR is ready to be discussed with and merged by the maintainers.
47
50
51
+ <a name =" more-complex-changes--building-the-php-documentation " ></a >
48
52
## More Complex Changes / Building the PHP documentation
49
53
50
54
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
59
63
and/or how PHP's documentation is built please refer to
60
64
the [ overview] ( overview.md ) .
61
65
66
+ <a name =" make-changes-to-the-documentation " ></a >
62
67
### Make changes to the documentation
63
68
64
69
[ Make your changes] ( editing.md ) keeping in mind the [ style guidelines] ( style.md ) .
65
70
71
+ <a name =" commit-changes-and-open-a-pr " ></a >
66
72
### Commit changes and open a PR
67
73
68
74
- commit your changes
0 commit comments