mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
9f1930a81e
* Updated docs + some small code changes * Added validating code doc for developers * Doc updates * Updates and improvements
29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
source: Developing/Validating-Code.md
|
|
|
|
As part of the pull request process with GitHub we run some automated build tests to ensure that
|
|
the code is error free, standards [compliant](http://docs.librenms.org/Developing/Code-Guidelines/)
|
|
and our test suite builds successfully.
|
|
|
|
Rather than submit a pull request and wait for the results, you can run these checks yourself to ensure
|
|
a more seamless merge.
|
|
|
|
> All of these commands should be run from within the librenms directory and can be run as the librenms user
|
|
unless otherwise noted.
|
|
|
|
Install composer (you can skip this if composer is already installed).
|
|
|
|
`curl -sS https://getcomposer.org/installer | php`
|
|
|
|
Composer will now be installed into /opt/librenms/composer.phar.
|
|
|
|
Now install the dependencies we require:
|
|
|
|
`composer install`
|
|
|
|
Once composer is installed you can now run the code validation script:
|
|
|
|
`./scripts/pre-commit.php`
|
|
|
|
If you see `Tests ok, submit away :)` then all is well. If you see other output then it should contain
|
|
what you need to resolve the issues and re-test.
|