Skip to content

Commit f3df67e

Browse files
ImperaZimImperaZim
committed
chore: complete repository documentation and quality tooling
1 parent 8f5e0c4 commit f3df67e

33 files changed

Lines changed: 727 additions & 0 deletions

‎.editorconfig‎

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

‎.gitattributes‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
* text=auto
2+
3+
*.php text eol=lf
4+
*.md text eol=lf
5+
*.json text eol=lf
6+
*.yml text eol=lf
7+
*.yaml text eol=lf
8+
*.neon text eol=lf
9+
*.xml text eol=lf
10+
*.stub text eol=lf
11+
12+
*.png binary
13+
*.jpg binary
14+
*.jpeg binary
15+
*.gif binary
16+
*.webp binary
17+
*.phar binary
18+
*.zip binary

‎.github/CODEOWNERS‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
2+
name: Bug report
3+
description: Report a reproducible bug or crash.
4+
title: "[Bug]: "
5+
labels: ["bug", "needs-triage"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a bug. Please include enough details so the issue can be reproduced.
11+
- type: input
12+
id: library-version
13+
attributes:
14+
label: Library / plugin version
15+
description: Example: 2.0.0, 1.1.0, latest development branch.
16+
placeholder: "2.0.0"
17+
validations:
18+
required: true
19+
- type: input
20+
id: pmmp-version
21+
attributes:
22+
label: PocketMine-MP version
23+
placeholder: "5.x.x"
24+
validations:
25+
required: false
26+
- type: input
27+
id: php-version
28+
attributes:
29+
label: PHP version
30+
placeholder: "8.2.x"
31+
validations:
32+
required: false
33+
- type: textarea
34+
id: steps
35+
attributes:
36+
label: Steps to reproduce
37+
description: List the smallest set of steps that trigger the issue.
38+
placeholder: |
39+
1. Install ...
40+
2. Run ...
41+
3. See error ...
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: expected
46+
attributes:
47+
label: Expected behavior
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: actual
52+
attributes:
53+
label: Actual behavior
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: logs
58+
attributes:
59+
label: Error, crashdump or relevant logs
60+
render: text
61+
validations:
62+
required: false
63+
- type: textarea
64+
id: extra
65+
attributes:
66+
label: Extra context
67+
validations:
68+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: Security report
5+
url: mailto:imperazim2@gmail.com
6+
about: Please report vulnerabilities privately instead of opening a public issue.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
name: Feature request
3+
description: Suggest an improvement or new capability.
4+
title: "[Feature]: "
5+
labels: ["enhancement", "needs-triage"]
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem / use case
11+
description: What are you trying to build or improve?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Proposed solution
18+
description: Describe the API, command, behavior or documentation change you want.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives considered
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: extra
29+
attributes:
30+
label: Extra context
31+
validations:
32+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
name: Question
3+
description: Ask a usage or integration question.
4+
title: "[Question]: "
5+
labels: ["question"]
6+
body:
7+
- type: textarea
8+
id: question
9+
attributes:
10+
label: Question
11+
description: Explain what you are trying to do and what you already tried.
12+
validations:
13+
required: true
14+
- type: input
15+
id: library-version
16+
attributes:
17+
label: Library / plugin version
18+
placeholder: "2.0.0"
19+
validations:
20+
required: false
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Context / code
25+
render: php
26+
validations:
27+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
## Summary
3+
4+
Describe what this pull request changes and why.
5+
6+
## Changes
7+
8+
- Describe the main change.
9+
10+
## Testing
11+
12+
- [ ] `composer validate --strict`
13+
- [ ] `composer run lint`
14+
- [ ] `composer run analyse`
15+
- [ ] `composer run test`
16+
- [ ] Tested on PocketMine-MP, when applicable
17+
18+
## Checklist
19+
20+
- [ ] I kept backward compatibility, or documented the breaking change.
21+
- [ ] I updated README/docs/examples when needed.
22+
- [ ] I updated CHANGELOG/release notes when needed.
23+
- [ ] I did not commit build artifacts, credentials or local-only files.

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
version: 2
3+
updates:
4+
- package-ecosystem: "composer"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
9+
- package-ecosystem: "github-actions"
10+
directory: "/"
11+
schedule:
12+
interval: "weekly"

‎.github/release.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
changelog:
3+
exclude:
4+
labels:
5+
- ignore-for-release
6+
categories:
7+
- title: Breaking changes
8+
labels:
9+
- breaking-change
10+
- breaking
11+
- title: Features
12+
labels:
13+
- enhancement
14+
- feature
15+
- title: Fixes
16+
labels:
17+
- bug
18+
- fix
19+
- title: Documentation
20+
labels:
21+
- documentation
22+
- docs
23+
- title: Maintenance
24+
labels:
25+
- dependencies
26+
- maintenance
27+
- ci
28+
- title: Other changes
29+
labels:
30+
- "*"

0 commit comments

Comments
 (0)