summaryrefslogtreecommitdiffstats
path: root/vendor/tedivm/jshrink/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 11:31:45 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 11:31:45 +0000
commit4e393913a4b1f06509da4341f0f58a41adac9117 (patch)
tree9c27e3eb77d109dff5fd031502311c5616adab04 /vendor/tedivm/jshrink/CONTRIBUTING.md
parentInitial commit. (diff)
downloadicinga-php-thirdparty-upstream.tar.xz
icinga-php-thirdparty-upstream.zip
Adding upstream version 0.12.1+ds.upstream/0.12.1+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/tedivm/jshrink/CONTRIBUTING.md')
-rw-r--r--vendor/tedivm/jshrink/CONTRIBUTING.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/vendor/tedivm/jshrink/CONTRIBUTING.md b/vendor/tedivm/jshrink/CONTRIBUTING.md
new file mode 100644
index 0000000..8fe815a
--- /dev/null
+++ b/vendor/tedivm/jshrink/CONTRIBUTING.md
@@ -0,0 +1,54 @@
+# Contributions Welcome!
+
+Pull Requests and Community Contributions are the bread and butter of open source software. Every contribution- from bug
+reports to feature requests, typos to full new features- are greatly appreciated.
+
+
+## Important Guidelines
+
+* One Item Per Pull Request or Issue. This makes it much easier to review code and merge it back in, and prevents issues
+ with one request from blocking another.
+
+* Code Coverage is extremely important, and pull requests are much more likely to be accepted if testing is also improved.
+ New code should be properly tested, and all tests must pass.
+
+* Read the LICENSE document and make sure you understand it, because your code is going to be released under it.
+
+* Be prepared to make revisions. Don't be discouraged if you're asked to make changes, as that is just another step
+ towards refining the code and getting it merged back in.
+
+* Remember to add the relevant documentation, particular the docblock comments.
+
+
+## Code Styling
+
+This project follows the PSR standards set forth by the [PHP Framework Interop Group](http://www.php-fig.org/).
+
+* [PSR-0: Class and file naming conventions](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
+* [PSR-1: Basic coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
+* [PSR-2: Coding style guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
+
+All code most follow these standards to be accepted. The easiest way to accomplish this is to run php-cs-fixer once the
+new changes are finished. The php-cs-fixer package is installed as a development dependency of this project.
+
+ composer install --dev
+ vendor/bin/php-cs-fixer fix ./ --level="all" -vv
+
+
+## Running the test suite
+
+First install dependencies using Composer. It's important to include the dev packages:
+
+ composer install --dev
+
+The "runTests.sh" script runs the full test suite- phpunit, php-cs-fixer, as well as any environmental setup:
+
+ tests/runTests.sh
+
+To call phpunit directly:
+
+ vendor/bin/phpunit
+
+To call php-cs-fixer directly:
+
+ vendor/bin/php-cs-fixer fix ./ --level="all" -vv --dry-run