Skip to content

Commit 136f8e6

Browse files
HafizMMoazclaude
HafizMMoaz
and
claude
authored
chore: add community health files (#15)
Add CONTRIBUTING.md, CODE_OF_CONDUCT.md, GitHub issue forms (bug report, feature request, documentation) and a pull request template, plus SECURITY.md where it was missing. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 11042fe commit 136f8e6

7 files changed

Lines changed: 403 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Bug report
2+
description: Report something that is broken or behaves incorrectly.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug.
10+
11+
**Do not report security vulnerabilities here.** See SECURITY.md and email
12+
`thewebisters@gmail.com` instead.
13+
14+
- type: checkboxes
15+
id: checks
16+
attributes:
17+
label: Before you start
18+
options:
19+
- label: I searched existing issues and this is not a duplicate.
20+
required: true
21+
- label: I am using a supported version (latest or LTS).
22+
required: true
23+
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: What happened?
28+
description: A clear description of the bug.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: What did you expect to happen?
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: reproduce
41+
attributes:
42+
label: Steps to reproduce
43+
description: Minimal steps or a code snippet that reproduces the problem.
44+
placeholder: |
45+
1. ...
46+
2. ...
47+
3. ...
48+
render: markdown
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: logs
54+
attributes:
55+
label: Error output
56+
description: Stack trace, exception message, or log excerpt. Pasted text is auto-formatted, no backticks needed.
57+
render: shell
58+
validations:
59+
required: false
60+
61+
- type: input
62+
id: php-version
63+
attributes:
64+
label: PHP version
65+
placeholder: "8.3.10"
66+
validations:
67+
required: true
68+
69+
- type: input
70+
id: package-version
71+
attributes:
72+
label: Package version
73+
description: Output of `composer show webisters/api`.
74+
placeholder: "1.2.0"
75+
validations:
76+
required: true
77+
78+
- type: dropdown
79+
id: os
80+
attributes:
81+
label: Operating system
82+
options:
83+
- Linux
84+
- macOS
85+
- Windows
86+
- Other
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: context
92+
attributes:
93+
label: Anything else?
94+
description: Server (nginx/apache/built-in), database version, relevant config.
95+
validations:
96+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question or discussion
4+
url: https://github.com/webisters/forum
5+
about: Ask usage questions and discuss ideas here instead of opening an issue.
6+
- name: Documentation
7+
url: https://webisters.com
8+
about: Read the Webisters guides and API reference.
9+
- name: Security vulnerability
10+
url: https://github.com/webisters/api/blob/main/SECURITY.md
11+
about: Report vulnerabilities privately by email, never as a public issue.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Documentation
2+
description: Report missing, unclear, or incorrect documentation.
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: input
7+
id: location
8+
attributes:
9+
label: Where is the documentation?
10+
description: URL, file path, or README section.
11+
placeholder: "README.md, Getting started section"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: problem
17+
attributes:
18+
label: What is wrong or missing?
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: suggestion
24+
attributes:
25+
label: Suggested wording or content
26+
validations:
27+
required: false
28+
29+
- type: checkboxes
30+
id: contribute
31+
attributes:
32+
label: Contribution
33+
options:
34+
- label: I am willing to open a pull request for this.
35+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature request
2+
description: Suggest a new feature or an improvement.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: checkboxes
7+
id: checks
8+
attributes:
9+
label: Before you start
10+
options:
11+
- label: I searched existing issues and this is not a duplicate.
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: What problem does this solve?
18+
description: Describe the use case, not just the solution.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: proposal
24+
attributes:
25+
label: Proposed solution
26+
description: What should the API or behaviour look like? Include a code sketch if you have one.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: alternatives
32+
attributes:
33+
label: Alternatives considered
34+
description: Workarounds you tried, or other designs you rejected and why.
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: breaking
40+
attributes:
41+
label: Would this break backwards compatibility?
42+
options:
43+
- "No"
44+
- "Yes"
45+
- "Not sure"
46+
validations:
47+
required: true
48+
49+
- type: checkboxes
50+
id: contribute
51+
attributes:
52+
label: Contribution
53+
options:
54+
- label: I am willing to open a pull request for this.
55+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- Thanks for contributing. Please fill this out so review is quick. -->
2+
3+
## Summary
4+
5+
<!-- What does this PR change and why? -->
6+
7+
## Related issue
8+
9+
Closes #
10+
11+
## Type of change
12+
13+
- [ ] Bug fix
14+
- [ ] New feature
15+
- [ ] Documentation
16+
- [ ] Refactor / internal change
17+
- [ ] Build, CI, or tooling
18+
19+
## Checklist
20+
21+
- [ ] I read [CONTRIBUTING.md](../CONTRIBUTING.md)
22+
- [ ] `vendor/bin/phpunit` passes locally
23+
- [ ] `vendor/bin/php-cs-fixer fix --dry-run --diff` reports no violations
24+
- [ ] Tests were added or updated for this change
25+
- [ ] Documentation (README or docs) was updated where needed
26+
- [ ] This change is backwards compatible (if not, describe the break below)
27+
28+
## Backwards compatibility notes
29+
30+
<!-- Leave "None" if nothing public changed. -->
31+
32+
None

‎CODE_OF_CONDUCT.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Code of Conduct
2+
3+
## Our pledge
4+
5+
We as members, contributors, and maintainers pledge to make participation in the
6+
Webisters community a harassment-free experience for everyone, regardless of age,
7+
body size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity and orientation.
10+
11+
## Our standards
12+
13+
Examples of behaviour that contributes to a positive environment:
14+
15+
- Demonstrating empathy and kindness toward other people
16+
- Being respectful of differing opinions, viewpoints, and experiences
17+
- Giving and gracefully accepting constructive feedback
18+
- Accepting responsibility, apologising to those affected by our mistakes, and
19+
learning from the experience
20+
- Focusing on what is best for the community
21+
22+
Examples of unacceptable behaviour:
23+
24+
- Sexualised language or imagery, and sexual attention or advances of any kind
25+
- Trolling, insulting or derogatory comments, and personal or political attacks
26+
- Public or private harassment
27+
- Publishing others' private information, such as a physical or email address,
28+
without their explicit permission
29+
- Other conduct which could reasonably be considered inappropriate in a professional
30+
setting
31+
32+
## Enforcement responsibilities
33+
34+
Maintainers are responsible for clarifying and enforcing these standards and will
35+
take appropriate and fair corrective action in response to any behaviour they deem
36+
inappropriate, threatening, offensive, or harmful. Maintainers may remove, edit, or
37+
reject comments, commits, code, issues, and other contributions that are not aligned
38+
with this Code of Conduct.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces (repositories, issues, pull
43+
requests, discussions) and also when an individual is officially representing the
44+
community in public spaces.
45+
46+
## Enforcement
47+
48+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported
49+
to the maintainers at `thewebisters@gmail.com`. All complaints will be reviewed and
50+
investigated promptly and fairly. Maintainers are obligated to respect the privacy
51+
and security of the reporter of any incident.
52+
53+
## Attribution
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
56+
version 2.1, available at
57+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
58+
59+
[homepage]: https://www.contributor-covenant.org

0 commit comments

Comments
 (0)