Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Bug report
description: Report something that is broken or behaves incorrectly.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug.

**Do not report security vulnerabilities here.** See SECURITY.md and email
`thewebisters@gmail.com` instead.

- type: checkboxes
id: checks
attributes:
label: Before you start
options:
- label: I searched existing issues and this is not a duplicate.
required: true
- label: I am using a supported version (latest or LTS).
required: true

- type: textarea
id: description
attributes:
label: What happened?
description: A clear description of the bug.
validations:
required: true

- type: textarea
id: expected
attributes:
label: What did you expect to happen?
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: Minimal steps or a code snippet that reproduces the problem.
placeholder: |
1. ...
2. ...
3. ...
render: markdown
validations:
required: true

- type: textarea
id: logs
attributes:
label: Error output
description: Stack trace, exception message, or log excerpt. Pasted text is auto-formatted, no backticks needed.
render: shell
validations:
required: false

- type: input
id: php-version
attributes:
label: PHP version
placeholder: "8.3.10"
validations:
required: true

- type: input
id: package-version
attributes:
label: Package version
description: Output of `composer show webisters/database-extra`.
placeholder: "1.2.0"
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating system
options:
- Linux
- macOS
- Windows
- Other
validations:
required: true

- type: textarea
id: context
attributes:
label: Anything else?
description: Server (nginx/apache/built-in), database version, relevant config.
validations:
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Question or discussion
url: https://github.com/webisters/forum
about: Ask usage questions and discuss ideas here instead of opening an issue.
- name: Documentation
url: https://webisters.com
about: Read the Webisters guides and API reference.
- name: Security vulnerability
url: https://github.com/webisters/database-extra/blob/main/SECURITY.md
about: Report vulnerabilities privately by email, never as a public issue.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Documentation
description: Report missing, unclear, or incorrect documentation.
title: "[Docs]: "
labels: ["documentation"]
body:
- type: input
id: location
attributes:
label: Where is the documentation?
description: URL, file path, or README section.
placeholder: "README.md, Getting started section"
validations:
required: true

- type: textarea
id: problem
attributes:
label: What is wrong or missing?
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: Suggested wording or content
validations:
required: false

- type: checkboxes
id: contribute
attributes:
label: Contribution
options:
- label: I am willing to open a pull request for this.
required: false
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Feature request
description: Suggest a new feature or an improvement.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: checkboxes
id: checks
attributes:
label: Before you start
options:
- label: I searched existing issues and this is not a duplicate.
required: true

- type: textarea
id: problem
attributes:
label: What problem does this solve?
description: Describe the use case, not just the solution.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: What should the API or behaviour look like? Include a code sketch if you have one.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Workarounds you tried, or other designs you rejected and why.
validations:
required: false

- type: dropdown
id: breaking
attributes:
label: Would this break backwards compatibility?
options:
- "No"
- "Yes"
- "Not sure"
validations:
required: true

- type: checkboxes
id: contribute
attributes:
label: Contribution
options:
- label: I am willing to open a pull request for this.
required: false
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- Thanks for contributing. Please fill this out so review is quick. -->

## Summary

<!-- What does this PR change and why? -->

## Related issue

Closes #

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactor / internal change
- [ ] Build, CI, or tooling

## Checklist

- [ ] I read [CONTRIBUTING.md](../CONTRIBUTING.md)
- [ ] `vendor/bin/phpunit` passes locally
- [ ] `vendor/bin/php-cs-fixer fix --dry-run --diff` reports no violations
- [ ] Tests were added or updated for this change
- [ ] Documentation (README or docs) was updated where needed
- [ ] This change is backwards compatible (if not, describe the break below)

## Backwards compatibility notes

<!-- Leave "None" if nothing public changed. -->

None
59 changes: 59 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Code of Conduct

## Our pledge

We as members, contributors, and maintainers pledge to make participation in the
Webisters community a harassment-free experience for everyone, regardless of age,
body size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our standards

Examples of behaviour that contributes to a positive environment:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility, apologising to those affected by our mistakes, and
learning from the experience
- Focusing on what is best for the community

Examples of unacceptable behaviour:

- Sexualised language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional
setting

## Enforcement responsibilities

Maintainers are responsible for clarifying and enforcing these standards and will
take appropriate and fair corrective action in response to any behaviour they deem
inappropriate, threatening, offensive, or harmful. Maintainers may remove, edit, or
reject comments, commits, code, issues, and other contributions that are not aligned
with this Code of Conduct.

## Scope

This Code of Conduct applies within all community spaces (repositories, issues, pull
requests, discussions) and also when an individual is officially representing the
community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported
to the maintainers at `thewebisters@gmail.com`. All complaints will be reviewed and
investigated promptly and fairly. Maintainers are obligated to respect the privacy
and security of the reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

[homepage]: https://www.contributor-covenant.org
Loading
Loading