Skip to content

Commit 3a5a334

Browse files
authored
Merge pull request #1 from MammatusPHP/full-package
Initial package set up
2 parents e1bea83 + 031b75a commit 3a5a334

28 files changed

+11894
-10
lines changed

.editorconfig

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

.gitattributes

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Ignoring files for distribution archieves
2+
.github/ export-ignore
3+
etc/ci/ export-ignore
4+
etc/qa/ export-ignore
5+
tests/ export-ignore
6+
var/ export-ignore
7+
.devcontainer.json export-ignore
8+
.editorconfig export-ignore
9+
.gitattributes export-ignore
10+
.gitignore export-ignore
11+
CONTRIBUTING.md export-ignore
12+
infection.json.dist export-ignore
13+
Makefile export-ignore
14+
README.md export-ignore

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @WyriHaximus

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: WyriHaximus

.github/boring-cyborg.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
labelPRBasedOnFilePath:
2+
"Documentation 📚":
3+
- README.md
4+
- CONTRIBUTING.md
5+
"Dependencies 📦":
6+
- Dockerfile*
7+
- composer.*
8+
- package.json
9+
- package-lock.json
10+
- yarn.lock
11+
"Docker 🐳":
12+
- Dockerfile*
13+
- .docker/**/*
14+
"Image 🖼":
15+
- "**/*.gif"
16+
- "**/*.jpg"
17+
- "**/*.jpeg"
18+
- "**/*.png"
19+
- "**/*.webp"
20+
"CSS 👩‍🎨":
21+
- "**/*.css"
22+
"HTML 👷‍♀️":
23+
- "**/*.htm"
24+
- "**/*.html"
25+
"NEON 🦹‍♂️":
26+
- "**/*.neon"
27+
"MarkDown 📝":
28+
- "**/*.md"
29+
"YAML 🍄":
30+
- "**/*.yml"
31+
- "**/*.yaml"
32+
"JSON 👨‍💼":
33+
- "**/*.json"
34+
"Go 🐹":
35+
- "**/*.go"
36+
"JavaScript 🦏":
37+
- "**/*.js"
38+
- package.json
39+
- package-lock.json
40+
- yarn.lock
41+
"PHP 🐘":
42+
- "**/*.php"
43+
- composer.*
44+
"Configuration ⚙":
45+
- .github/*
46+
"CI 🚧":
47+
- .github/workflows/*
48+
- .scrutinizer.yml
49+
"Templates 🌲":
50+
- "**/*.twig"
51+
- "**/*.tpl"
52+
"Helm ☸":
53+
- .helm/**/*
54+
"Tests 🧪":
55+
- tests/**/*
56+
"Source 🔮":
57+
- src/**/*
58+
59+
labelerFlags:
60+
labelOnPRUpdates: true

.github/renovate.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"github>WyriHaximus/renovate-config:php-package-dev"
5+
]
6+
}

.github/settings.yml

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
repository:
2+
private: false
3+
has_issues: true
4+
has_wiki: false
5+
has_downloads: true
6+
default_branch: master
7+
allow_squash_merge: false
8+
allow_merge_commit: true
9+
allow_rebase_merge: false
10+
11+
# Labels: define labels for Issues and Pull Requests
12+
labels:
13+
- name: "Deprecations 👋"
14+
color: ff7700
15+
- name: "Dependabot 🤖"
16+
color: 0366d6
17+
- name: "Dependencies 📦"
18+
color: 0025ff
19+
description: "Pull requests that update a dependency file"
20+
- name: "Image 🖼"
21+
color: 00ffff
22+
- name: "HTML 👷‍♀️"
23+
color: ffffff
24+
- name: "CSS 👩‍🎨"
25+
color: b3b3b3
26+
- name: "JavaScript 🦏"
27+
color: ffff00
28+
- name: "Go 🐹"
29+
color: 00ADD8
30+
- name: "JSON 👨‍💼"
31+
color: 00ADD8
32+
- name: "NEON 🦹‍♂️"
33+
color: CE3262
34+
- name: "MarkDown 📝"
35+
color: 000000
36+
- name: "YAML 🍄"
37+
color: ff1aff
38+
- name: "Templates 🌲"
39+
color: 009933
40+
- name: "Helm ☸"
41+
color: 091C84
42+
- name: "Tests 🧪"
43+
color: ffe6e6
44+
- name: "Source 🔮"
45+
color: e6ffe6
46+
- name: "Configuration ⚙"
47+
color: b3b3cc
48+
- name: "PHP 🐘"
49+
color: 8892BF
50+
description: "Hypertext Pre Processor"
51+
- name: "Docker 🐳"
52+
color: 0db7ed
53+
description: "Pull requests that relate to Docker"
54+
- name: "CI 🚧"
55+
color: ffff00
56+
- name: "Feature 🏗"
57+
color: 66ff99
58+
- name: "Documentation 📚"
59+
color: 6666ff
60+
- name: "Security 🕵️‍♀️"
61+
color: ff0000
62+
- name: "Hacktoberfest 🎃"
63+
color: 152347
64+
- name: "Bug 🐞"
65+
color: d73a4a
66+
description: "Something isn't working"
67+
oldname: bug
68+
- name: "Duplicate ♊"
69+
color: cfd3d7
70+
description: "This issue or pull request already exists"
71+
oldname: duplicate
72+
- name: "Enhancement ✨"
73+
color: a2eeef
74+
description: "New feature or request"
75+
oldname: enhancement
76+
- name: "Good First Issue"
77+
color: 7057ff
78+
description: "Good for newcomers"
79+
oldname: "good first issue"
80+
- name: "Help Wanted"
81+
color: 008672
82+
description: "Extra attention is needed"
83+
oldname: "help wanted"
84+
- name: Invalid
85+
color: e4e669
86+
description: "This doesn't seem right"
87+
oldname: invalid
88+
- name: "Question ❓"
89+
color: d876e3
90+
description: "Further information is requested"
91+
oldname: question
92+
- name: "Will not be fixed 🛑"
93+
color: ffffff
94+
description: "This will not be worked on"
95+
oldname: wontfix
96+
- name: "Sponsor Request ❤️"
97+
color: fedbf0
98+
description: "Issue/PR opened by sponsor"
99+
100+
branches:
101+
- name: master
102+
protection:
103+
required_pull_request_reviews:
104+
required_approving_review_count: 1
105+
dismiss_stale_reviews: true
106+
require_code_owner_reviews: true
107+
# Required. Require status checks to pass before merging. Set to null to disable
108+
required_status_checks:
109+
# Required. Require branches to be up to date before merging.
110+
strict: true
111+
# Required. The list of status checks to require in order to merge into this branch
112+
contexts: [
113+
"Milestone Check",
114+
"✔️"
115+
]
116+
# Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
117+
enforce_admins: true
118+
# Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
119+
restrictions:
120+
apps: []
121+
users: []
122+
teams: []

.github/workflows/ci.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Continuous Integration
2+
on:
3+
push:
4+
branches:
5+
- 'main'
6+
- 'master'
7+
- 'refs/heads/v[0-9]+.[0-9]+.[0-9]+'
8+
pull_request:
9+
## This workflow needs the `pull-request` permissions to work for the package diffing
10+
## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions
11+
permissions:
12+
pull-requests: write
13+
contents: read
14+
jobs:
15+
ci:
16+
name: Continuous Integration
17+
uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@main
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Release Management
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
- labeled
7+
- unlabeled
8+
- synchronize
9+
- reopened
10+
- milestoned
11+
- demilestoned
12+
- ready_for_review
13+
milestone:
14+
types:
15+
- closed
16+
permissions:
17+
contents: write
18+
issues: write
19+
pull-requests: write
20+
jobs:
21+
release-managment:
22+
name: Create Release
23+
uses: WyriHaximus/github-workflows/.github/workflows/package-release-managment.yaml@main
24+
with:
25+
milestone: ${{ github.event.milestone.title }}
26+
description: ${{ github.event.milestone.title }}

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
var/*
2+
!var/.gitkeep
3+
src/Generated/*
4+
!src/Generated/.gitkeep
5+
vendor/
6+
etc/qa/.phpunit.result.cache

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Pull requests are highly appreciated. Here's a quick guide.
4+
5+
Fork, then clone the repo:
6+
7+
git clone git@github.com:your-username/json.git
8+
9+
Set up your machine:
10+
11+
composer install
12+
13+
Make sure the tests pass:
14+
15+
make unit
16+
17+
Make sure the tests pass on all supported PHP versions (requires docker):
18+
19+
make dunit
20+
21+
Make your change. Add tests for your change. Make the tests pass:
22+
23+
make dunit && make unit
24+
25+
Before committing and submitting your pull request make sure it passes PSR2 coding style, unit tests pass and pass on all supported PHP versions:
26+
27+
make contrib
28+
29+
Push to your fork and [submit a pull request][pr].
30+
31+
[pr]: https://help.github.com/articles/creating-a-pull-request/
32+
33+
At this point you're waiting on me. I like to at least comment on pull requests
34+
within a day or two. I may suggest some changes or improvements or alternatives.
35+
36+
Some things that will increase the chance that your pull request is accepted:
37+
38+
* Write tests.
39+
* Follow PSR2 (travis will also check for this).
40+
* Write a [good commit message][commit].
41+
42+
[commit]: http://chris.beams.io/posts/git-commit/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 reactive-apps
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)