Skip to content

Commit 6f4a1d8

Browse files
author
Martin Fris
authored
Merge pull request #1 from pixelfederation/open_source
Open source release
2 parents 8ca0097 + 83bf37a commit 6f4a1d8

17 files changed

+1134
-84
lines changed

.allowed-licenses

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- BSD-3-Clause
2+
- LGPL-3.0-or-later
3+
- MIT

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright 2021 Pixel Federation s.r.o.
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided
4+
that the following conditions are met:
5+
6+
1. Redistributions of source code must retain the above copyright notice, this list of conditions
7+
and the following disclaimer.
8+
9+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
10+
and the following disclaimer in the documentation and/or other materials provided with the distribution.
11+
12+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse
13+
or promote products derived from this software without specific prior written permission.
14+
15+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16+
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
20+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
21+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Coding standards
22

3-
This package provides PHPCS rule set for coding standards in Pixelfederation. It should be included into
4-
each project that uses PHPCS.
3+
This package provides PHPCS rule set for coding standards in Pixel Federation. It should be included into
4+
each project maintained by Pixel Federation that uses PHP Code Sniffer [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer).
55

66
## Example usage
77

88
### 1) Install composer dependencies
99

1010
```bash
11-
composer require pixelfederation/coding-standards:^1.0 --dev
11+
composer require pixelfederation/coding-standards:^2.0 --dev
1212
```
1313

1414
### 2) Ruleset creation
@@ -29,8 +29,6 @@ Create a file named `phpcs.ruleset.xml` to the root folder of your project with
2929
<exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
3030
<exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
3131
<exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/> -->
32-
<!-- v mastry ale este nie v relese maju takuto smakocinku, takze potom to pripadne exludnite -->
33-
<!-- https://github.com/slevomat/coding-standard/blob/master/SlevomatCodingStandard/Sniffs/Files/FunctionLengthSniff.php -->
3432
<!-- <exclude name="SlevomatCodingStandard.Files.FunctionLength"/> -->
3533
</rule>
3634

composer.json

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,21 @@
33
"homepage": "https://git.pixelfederation.com/shared/server-coding-standards",
44
"type": "library",
55
"description": "Standardized PHPCS sniffs for backend developers.",
6-
"license": "proprietary",
6+
"license": "BSD-3-Clause",
77
"authors": [
88
{
99
"name": "Martin Fris",
1010
"email": "[email protected]"
1111
}
1212
],
13-
"repositories": [
14-
{
15-
"type": "composer",
16-
"url": "https://satis.pxfd.tech"
17-
}
18-
],
1913
"require": {
2014
"php": ">=7.2",
2115
"phpcompatibility/php-compatibility": "^9.3",
2216
"slevomat/coding-standard": "^7.0.9",
2317
"squizlabs/php_codesniffer": "^3.5"
2418
},
2519
"require-dev": {
20+
"madewithlove/license-checker": "^0.10.0"
2621
},
2722
"autoload": {
2823
"psr-4": {

0 commit comments

Comments
 (0)