@@ -46,8 +46,41 @@ of the Java `metadata-extractor`.
4646Stable versions of ` php-metadata-extrator ` will be equal to ` X.Y.Z-N ` where ` N ` represents a patch number
4747associated to ` php-metadata-extractor ` .
4848
49- Unstable or uncomplete versions of ` php-metadata-extractor ` will be equal to ` X.Y.Z-alpha.N ` or
50- ` X.Y.Z-beta.N ` .
49+ Unstable or uncomplete versions of ` php-metadata-extractor ` will be equal to ` X.Y.Z-alpha.N ` ,
50+ ` X.Y.Z-beta.N ` or ` X.Y.Z-rc.N ` .
51+
52+ ## Contribute
53+
54+ ### Rules
55+
56+ The ` metadata-extractor ` Java library is very complete, so we need to improve its integration, if you would like
57+ to contribute please respect the following rules :
58+
59+ * Create your pull requests only on the ` develop ` branch, the ` master ` branch should only be used by Gomoob to
60+ create new versions ;
61+ * Use the ` grunt phpcbf ` command to automatically format your code with PHP Code Sniffer ;
62+ * Use the ` grunt phpcs ` command to check your code before creating your Pull request ;
63+ * Always try to fully document your classes, properties and functions.
64+
65+ ### Builds
66+
67+ The build scripts are managed with [ Grunt] ( "Grunt" ) , to use is you first have to install [ Node] ( "Node" ) and use the
68+ ` npm install ` .
69+
70+ The PHP dependencies are managed with [ Composer] ( "Composer" ) , run the ` composer update ` command before calling any
71+ build command.
72+
73+ Ensure you have a working Java environnement and that the ` java ` executable is available in your ` PATH ` .
74+
75+ The following builds are available :
76+
77+ * ` grunt ` clean temporary build files, run the PHPUnit unit tests and generated the PHPDocumentor documentation ;
78+ * ` grunt phpcbf ` automatically clean the source code for PHP Code Sniffer ;
79+ * ` grunt phpcs ` check the validity of the source code with PHP Code Sniffer ;
80+ * ` grunt test ` execute the PHPUnit unit tests ;
81+ * ` grunt generate-documentation ` generate the PHPDocumentor documentation ;
82+ * ` grunt pdepend ` generate the PDepend quality charts ;
83+ * ` grunt phpmd ` generate the PHPMD code quality reports.
5184
5285## About Gomoob
5386
0 commit comments