Skip to content

Commit 3d31f53

Browse files
authored
Merge pull request #83 from localheinz/feature/synchronize
Enhancement: Synchronize with `ergebnis/php-package-template`
2 parents 12cb4a0 + e7bb250 commit 3d31f53

21 files changed

+297
-179
lines changed

.editorconfig

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ root = true
22

33
[*]
44
charset = utf-8
5+
end_of_line = lf
56
indent_size = 4
67
indent_style = space
78
insert_final_newline = true
@@ -10,6 +11,9 @@ trim_trailing_whitespace = true
1011
[*.json]
1112
indent_size = 2
1213

14+
[*.md]
15+
indent_size = 2
16+
1317
[*.{yaml,yml}]
1418
indent_size = 2
1519

.gitattributes

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
/.editorconfig export-ignore
55
/.gitattributes export-ignore
66
/.gitignore export-ignore
7-
/.php_cs.dist export-ignore
7+
/.php-cs-fixer.php export-ignore
8+
/.yamllint.yaml export-ignore
89
/Makefile export-ignore
10+
/phive.xml export-ignore
911
/phpunit.xml export-ignore
12+
/psalm.xml export-ignore

.github/CODEOWNERS

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

.github/CODE_OF_CONDUCT.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

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
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
1616

1717
Examples of unacceptable behavior by participants include:
1818

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
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
2424

2525
## Our Responsibilities
2626

.github/CONTRIBUTING.md

+26-13
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,70 @@
1-
# CONTRIBUTING
1+
# Contributing
22

3-
We are using [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
3+
We use [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
44

55
For details, take a look at the following workflow configuration files:
66

77
- [`workflows/integrate.yaml`](workflows/integrate.yaml)
8+
- [`workflows/merge.yaml`](workflows/merge.yaml)
89
- [`workflows/release.yaml`](workflows/release.yaml)
910
- [`workflows/triage.yaml`](workflows/triage.yaml)
1011

12+
## Backward-Compatibility Analysis
13+
14+
We use [`roave/backward-compatibility-check`](https://github.com/Roave/BackwardCompatibilityCheck) to prevent breaking backwards-compatibility.
15+
16+
Run
17+
18+
```sh
19+
make backward-compatibility-analysis
20+
```
21+
22+
to run a backward-compatibility analysis.
23+
1124
## Coding Standards
1225

13-
We are using [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
26+
We use [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
1427

15-
We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
28+
We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
1629

1730
If you do not have `yamllint` installed yet, run
1831

1932
```sh
20-
$ brew install yamllint
33+
brew install yamllint
2134
```
2235

2336
to install `yamllint`.
2437

25-
We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files.
38+
We use [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files.
2639

2740
Run
2841

2942
```sh
30-
$ make coding-standards
43+
make coding-standards
3144
```
3245

3346
to automatically fix coding standard violations.
3447

3548
## Static Code Analysis
3649

37-
We are using [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
50+
We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
3851

3952
Run
4053

4154
```sh
42-
$ make static-code-analysis
55+
make static-code-analysis
4356
```
4457

4558
to run a static code analysis.
4659

4760
## Tests
4861

49-
We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
62+
We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.
5063

5164
Run
5265

5366
```sh
54-
$ make tests
67+
make tests
5568
```
5669

5770
to run all the tests.
@@ -61,7 +74,7 @@ to run all the tests.
6174
Run
6275

6376
```sh
64-
$ make
77+
make
6578
```
6679

6780
to enforce coding standards, run a static code analysis, and run tests!
@@ -71,7 +84,7 @@ to enforce coding standards, run a static code analysis, and run tests!
7184
:bulb: Run
7285

7386
```sh
74-
$ make help
87+
make help
7588
```
7689

7790
to display a list of available targets with corresponding descriptions.

.github/FUNDING.yaml

+5
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/FUNDING.yml

-1
This file was deleted.

.github/ISSUE_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
#### Expected Result
88

9-
*
9+
-
1010

1111
#### Actual Result
1212

13-
*
13+
-

.github/PULL_REQUEST_TEMPLATE.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
This PR
1+
This pull request
22

3-
* [x]
4-
* [ ]
3+
- [x]
54

65
Follows #.
76
Related to #.

.github/SECURITY.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The following versions of `localheinz/diff` have active support:
6+
7+
- `^1.1.0`
8+
9+
## Unsupported Versions
10+
11+
The following versions of `localheinz/diff` have reached their end of life:
12+
13+
- `<1.1.0`
14+
15+
## Reporting a Vulnerability
16+
17+
If you believe that you have found a security vulnerability, please send an email to `am@localheinz.com`. Ensure to include all details required to understand the severity of the issue.

.github/dependabot.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
2+
3+
version: 2
4+
5+
updates:
6+
- allow:
7+
- dependency-type: "development"
8+
commit-message:
9+
include: "scope"
10+
prefix: "composer"
11+
directory: "/"
12+
ignore:
13+
- dependency-name: "phpunit/phpunit"
14+
- dependency-name: "symfony/process"
15+
labels:
16+
- "dependency"
17+
open-pull-requests-limit: 10
18+
package-ecosystem: "composer"
19+
schedule:
20+
interval: "weekly"
21+
versioning-strategy: "increase"
22+
23+
- commit-message:
24+
include: "scope"
25+
prefix: "github-actions"
26+
directory: "/"
27+
labels:
28+
- "dependency"
29+
open-pull-requests-limit: 10
30+
package-ecosystem: "github-actions"
31+
schedule:
32+
interval: "weekly"

.github/dependabot.yml

-15
This file was deleted.

.github/release.yaml

+6
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"

.github/settings.yml

+25-23
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# https://github.com/probot/settings
1+
# https://github.com/repository-settings/app
22

33
branches:
44
- name: "main"
@@ -13,19 +13,21 @@ branches:
1313
require_code_owner_reviews: true
1414
required_approving_review_count: 1
1515
required_status_checks:
16-
contexts:
17-
- "Code Coverage (7.4, highest)"
18-
- "Coding Standards (7.1)"
19-
- "Tests (7.1, highest)"
20-
- "Tests (7.1, lowest)"
21-
- "Tests (7.2, highest)"
22-
- "Tests (7.2, lowest)"
23-
- "Tests (7.3, highest)"
24-
- "Tests (7.3, lowest)"
25-
- "Tests (7.4, highest)"
26-
- "Tests (7.4, lowest)"
27-
- "Tests (8.0, highest)"
28-
- "Tests (8.0, lowest)"
16+
checks:
17+
- context: "Backward-Compatibility Analysis (7.4, locked)"
18+
- context: "Code Coverage (7.4, locked)"
19+
- context: "Coding Standards (7.4, locked)"
20+
- context: "Static Code Analysis (7.4, locked)"
21+
- context: "Tests (7.1, highest)"
22+
- context: "Tests (7.1, lowest)"
23+
- context: "Tests (7.2, highest)"
24+
- context: "Tests (7.2, lowest)"
25+
- context: "Tests (7.3, highest)"
26+
- context: "Tests (7.3, lowest)"
27+
- context: "Tests (7.4, highest)"
28+
- context: "Tests (7.4, lowest)"
29+
- context: "Tests (8.0, highest)"
30+
- context: "Tests (8.0, lowest)"
2931
strict: false
3032
restrictions: null
3133

@@ -45,10 +47,6 @@ labels:
4547
color: "0e8a16"
4648
description: ""
4749

48-
- name: "merge"
49-
color: "6f42c1"
50-
description: ""
51-
5250
- name: "question"
5351
color: "cc317c"
5452
description: ""
@@ -57,10 +55,6 @@ labels:
5755
color: "ee0701"
5856
description: ""
5957

60-
- name: "stale"
61-
color: "eeeeee"
62-
description: ""
63-
6458
# https://docs.github.com/en/rest/reference/repos#update-a-repository
6559

6660
repository:
@@ -71,10 +65,18 @@ repository:
7165
default_branch: "main"
7266
delete_branch_on_merge: true
7367
description: ":fork_and_knife: Fork of sebastian/diff for use with ergebnis/composer-normalize."
68+
enable_automated_security_fixes: true
69+
enable_vulnerability_alerts: true
70+
has_discussions: false
7471
has_downloads: true
75-
has_issues: false
72+
has_issues: true
7673
has_pages: false
7774
has_projects: false
7875
has_wiki: false
76+
is_template: false
7977
name: "diff"
8078
private: false
79+
80+
# https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics
81+
82+
topics: "php, diff"

0 commit comments

Comments
 (0)