Skip to content

Commit 527049d

Browse files
committed
Initial commit
0 parents  commit 527049d

34 files changed

+7889
-0
lines changed

.editorconfig

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_size = 4
6+
indent_style = space
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true
9+
10+
[*.json]
11+
indent_size = 2
12+
13+
[*.md]
14+
indent_size = 2
15+
16+
[*.neon]
17+
indent_style = tab
18+
19+
[*.{yaml,yml}]
20+
indent_size = 2
21+
22+
[Makefile]
23+
indent_style = tab

.gitattributes

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/.github/ export-ignore
2+
/.phive/ export-ignore
3+
/.editorconfig export-ignore
4+
/.gitattributes export-ignore
5+
/.gitignore export-ignore
6+
/.php-cs-fixer.php export-ignore
7+
/.yamllint.yaml export-ignore
8+
/autoloader.php export-ignore
9+
/composer-require-checker.json export-ignore
10+
/composer.lock export-ignore
11+
/Makefile export-ignore
12+
/psalm-baseline.xml export-ignore
13+
/psalm.xml export-ignore
14+
/rector.php export-ignore

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-size
2+
3+
* @ergebnis-bot @localheinz

.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at am@localheinz.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# CONTRIBUTING
2+
3+
We are using [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
4+
5+
For details, take a look at the following workflow configuration files:
6+
7+
- [`workflows/integrate.yaml`](workflows/integrate.yaml)
8+
- [`workflows/merge.yaml`](workflows/merge.yaml)
9+
- [`workflows/release.yaml`](workflows/release.yaml)
10+
- [`workflows/renew.yaml`](workflows/renew.yaml)
11+
- [`workflows/triage.yaml`](workflows/triage.yaml)
12+
13+
## Coding Standards
14+
15+
We are using [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
16+
17+
We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
18+
19+
If you do not have `yamllint` installed yet, run
20+
21+
```sh
22+
brew install yamllint
23+
```
24+
25+
to install `yamllint`.
26+
27+
We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files.
28+
29+
Run
30+
31+
```sh
32+
make coding-standards
33+
```
34+
35+
to automatically fix coding standard violations.
36+
37+
## Dependency Analysis
38+
39+
We are using [`maglnet/composer-require-checker`](https://github.com/maglnet/ComposerRequireChecker) to prevent the use of unknown symbols in production code.
40+
41+
Run
42+
43+
```sh
44+
make dependency-analysis
45+
```
46+
47+
to run a dependency analysis.
48+
49+
## Refactoring
50+
51+
We are using [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.
52+
53+
Run
54+
55+
```sh
56+
make refactoring
57+
```
58+
59+
to automatically refactor code.
60+
61+
## Security Analysis
62+
63+
We are using [`composer`](https://github.com/composer/composer) to run a security analysis.
64+
65+
Run
66+
67+
```sh
68+
make security-analysis
69+
```
70+
71+
to run a security analysis.
72+
73+
## Static Code Analysis
74+
75+
We are using [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
76+
77+
Run
78+
79+
```sh
80+
make static-code-analysis
81+
```
82+
83+
to run a static code analysis.
84+
85+
We are also using the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file).
86+
87+
Run
88+
89+
```sh
90+
make static-code-analysis-baseline
91+
```
92+
93+
to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
94+
95+
:exclamation: Ideally, the baseline should shrink over time.
96+
97+
98+
## Extra lazy?
99+
100+
Run
101+
102+
```sh
103+
make
104+
```
105+
106+
to automatically refactor code, enforce coding standards, and run a static code analysis!
107+
108+
## Help
109+
110+
:bulb: Run
111+
112+
```sh
113+
make help
114+
```
115+
116+
to display a list of available targets with corresponding descriptions.

.github/FUNDING.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository
2+
3+
github:
4+
- "ergebnis"
5+
- "localheinz"

.github/ISSUE_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#### Steps required to reproduce the problem
2+
3+
1.
4+
2.
5+
3.
6+
7+
#### Expected Result
8+
9+
-
10+
11+
#### Actual Result
12+
13+
-

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This pull request
2+
3+
- [x]
4+
5+
Follows #.
6+
Related to #.
7+
Fixes #.

.github/dependabot.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
2+
3+
version: 2
4+
5+
updates:
6+
- commit-message:
7+
include: "scope"
8+
prefix: "composer"
9+
directory: "/"
10+
labels:
11+
- "dependency"
12+
open-pull-requests-limit: 10
13+
package-ecosystem: "composer"
14+
schedule:
15+
interval: "daily"
16+
versioning-strategy: "increase"
17+
18+
- commit-message:
19+
include: "scope"
20+
prefix: "github-actions"
21+
directory: "/"
22+
labels:
23+
- "dependency"
24+
open-pull-requests-limit: 10
25+
package-ecosystem: "github-actions"
26+
schedule:
27+
interval: "daily"

.github/release.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes
2+
3+
changelog:
4+
exclude:
5+
authors:
6+
- "dependabot"

0 commit comments

Comments
 (0)