com php-langspec: Mention generated files + pre-commit hook in CONTRIBUTING: CONTRIBUTING.md
[email protected] (Nikita Popov) Tue, 26 Sep 2017 08:59:40 +0000
| Newsgroups | php.standards.cvs |
|---|---|
| Message-ID | <[email protected]> |
Commit: b0e2ca93602b649d936295a0fceaec5381b64101=0AAuthor: Nikita Pop= ov <[email protected]> Tue, 26 Sep 2017 10:59:40 +0200=0AParents= : 7741beb3af80779a223bc61ef0d4d7a31bf12f50=0ABranches: master=0A=0ALink:= http://git.php.net/?p=3Dphp-langspec.git;a=3Dcommitdiff;h=3Db0e2ca93= 602b649d936295a0fceaec5381b64101=0A=0ALog:=0AMention generated files + pre-= commit hook in CONTRIBUTING=0A=0AChanged paths:=0A M CONTRIBUTING.md=0A= =0A=0ADiff:=0Adiff --git a/CONTRIBUTING.md b/CONTRIBUTING.md=0Aindex 0b6090= 1..681fd4b 100644=0A--- a/CONTRIBUTING.md=0A+++ b/CONTRIBUTING.md=0A@@ -1,8= +1,24 @@=0A ## Contributing to the Specification for PHP=0A =0A We'd love = your help in improving, correcting, adding to the specification.=0A-Please = [file an issue](https://bugs.php.net/) or [submit a pull request](https://w= iki.php.net/vcs/gitworkflow)=0A-at the [spec git repo](https://github.com/p= hp/php-langspec).=0A+Please [file an issue](https://github.com/php/php-lang= spec/issues)=0A+or [submit a pull request](https://github.com/php/php-langs= pec/pulls).=0A+=0A+## Generated content=0A+=0A+The grammar listings and tab= le of contents of the specification are automatically=0A+generated. If you = want to change the grammar, you need to modify the respective=0A+`<!--GRAMM= AR` block and run `tools/grammar.php` to regenerate the rendered listings.= =0A+If you add or change headings, you need to regenerate the TOC using `to= ols/toc.php`.=0A+Additionally `tools/check_refs.php` can be run to verify t= hat all cross-references=0A+are valid.=0A+=0A+To combine these three steps = you can instead execute `tools/pre-commit`. To=0A+automatically run it on e= very commit, create a symlink in the `.git/hooks` directory:=0A+=0A+```sh= =0A+ln -s -f ../../tools/pre-commit .git/hooks/pre-commit=0A+```=0A =0A ## = License for your Contributions=0A