Skip to content

Commit 115b652

Browse files
aurimasniekisaurimasniekis
committed
Initial Commit
0 parents  commit 115b652

15 files changed

+647
-0
lines changed

‎.editorconfig

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.editorconfig export-ignore
6+
/.gitattributes export-ignore
7+
/.gitignore export-ignore
8+
/.scrutinizer.yml export-ignore
9+
/.travis.yml export-ignore
10+
/PULL_REQUEST_TEMPLATE.md export-ignore
11+
/ISSUE_TEMPLATE.md export-ignore
12+
/phpcs.xml.dist export-ignore
13+
/phpunit.xml.dist export-ignore
14+
/tests export-ignore
15+
/docs export-ignore

‎.github/workflows/main.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Continuous Integration
2+
on: [ push, pull_request ]
3+
jobs:
4+
main:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- name: Checkout
8+
uses: actions/checkout@v2
9+
- name: Setup PHP, with composer and extensions
10+
uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
11+
with:
12+
php-version: '8.0'
13+
coverage: xdebug
14+
- name: Install Composer dependencies
15+
run: |
16+
composer self-update --no-interaction
17+
composer update --no-interaction --prefer-dist --optimize-autoloader
18+
- name: Run CI Commands
19+
run: |
20+
composer ci-run

‎.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
build
2+
composer.lock
3+
vendor
4+
phpcs.xml
5+
phpunit.xml
6+
infection.json
7+
.phpunit.result.cache
8+
.php_cs.cache
9+
coverage.clover

‎.php_cs.dist

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
$finder = PhpCsFixer\Finder::create()
4+
->in([__DIR__ . '/src', __DIR__ . '/tests']);
5+
6+
return PhpCsFixer\Config::create()
7+
->setRiskyAllowed(true)
8+
->setRules(
9+
[
10+
'@Symfony' => true,
11+
'binary_operator_spaces' => ['align_double_arrow' => true, 'align_equals' => true],
12+
'ordered_imports' => true,
13+
'array_syntax' => ['syntax' => 'short'],
14+
'void_return' => true,
15+
'declare_strict_types' => true,
16+
'yoda_style' => true,
17+
'increment_style' => ['style' => 'post'],
18+
'concat_space' => ['spacing' => 'one'],
19+
]
20+
)
21+
->setFinder($finder)
22+
->setUsingCache(true);

‎CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Contributing
2+
3+
If you're here, you would like to contribute to this repository and you're really welcome!
4+
5+
6+
## Bug reports
7+
8+
If you find a bug or a documentation issue, please report it or even better: fix it :). If you report it,
9+
please be as precise as possible. Here is a little list of required information:
10+
11+
- Precise description of the bug
12+
- Details of your environment (for example: OS, PHP version, installed extensions)
13+
- Backtrace which might help identifing the bug
14+
15+
16+
## Feature requests
17+
18+
If you think a feature is missing, please report it or even better: implement it :). If you report it, describe the more
19+
precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
20+
some research before submitting it and link the resources to your description, you're awesome! It will allow us to more
21+
easily understood/implement it.
22+
23+
24+
## Sending a Pull Request
25+
26+
If you're here, you are going to fix a bug or implement a feature and you're the best!
27+
To do it, first fork the repository, clone it and create a new branch with the following commands:
28+
29+
``` bash
30+
$ git clone git@github.com:your-name/pz-composer.git
31+
$ git checkout -b feature-or-bug-fix-description
32+
```
33+
34+
Then install the dependencies through [Composer](https://getcomposer.org/):
35+
36+
``` bash
37+
$ composer install
38+
```
39+
40+
Write code and tests. When you are ready, run the tests.
41+
(This is usually [PHPUnit](http://phpunit.de/))
42+
43+
``` bash
44+
$ composer test
45+
```
46+
47+
When you are ready with the code, tested it and documented it, you can commit and push it with the following commands:
48+
49+
``` bash
50+
$ git commit -m "Feature or bug fix description"
51+
$ git push origin feature-or-bug-fix-description
52+
```
53+
54+
**Note:** Please write your commit messages in the imperative and follow the
55+
[guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for clear and concise messages.
56+
57+
Then [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub.
58+
59+
Please make sure that each individual commit in your pull request is meaningful.
60+
If you had to make multiple intermediate commits while developing,
61+
please squash them before submitting with the following commands
62+
(here, we assume you would like to squash 3 commits in a single one):
63+
64+
``` bash
65+
$ git rebase -i HEAD~3
66+
```
67+
68+
If your branch conflicts with the master branch, you will need to rebase and repush it with the following commands:
69+
70+
``` bash
71+
$ git remote add upstream git@github.com:project-zer0/pz-composer.git
72+
$ git pull --rebase upstream master
73+
$ git push -f origin feature-or-bug-fix-description
74+
```
75+
76+
77+
## Coding standard
78+
79+
This repository follows the [PSR-2 standard](http://www.php-fig.org/psr/psr-2/) and so, if you want to contribute,
80+
you must follow these rules.
81+
82+
83+
## Semver
84+
85+
We are trying to follow [semver](http://semver.org/). When you are making BC breaking changes,
86+
please let us know why you think it is important.
87+
In this case, your patch can only be included in the next major version.
88+
89+
90+
## Code of Conduct
91+
92+
This project is released with a [Contributor Code of Conduct](CONDUCT.md).
93+
By participating in this project you agree to abide by its terms.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2021 Aurimas Niekis
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)