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
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Bug report
description: Report a reproducible problem
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug.

Security vulnerabilities do not belong in a public issue.
Please follow SECURITY.md and email thewebisters@gmail.com.

- type: checkboxes
id: duplicate_search
attributes:
label: Duplicate search
options:
- label: I searched the existing issues and found no duplicate.
required: true

- type: textarea
id: what_happened
attributes:
label: What happened?
description: Describe the problem clearly.
placeholder: Tell us what went wrong.
validations:
required: true

- type: textarea
id: expected_behaviour
attributes:
label: Expected behaviour
description: Describe what you expected to happen.
placeholder: Tell us what should have happened.
validations:
required: true

- type: textarea
id: steps_to_reproduce
attributes:
label: Steps to reproduce
description: Provide the smallest set of steps that reproduces the problem.
placeholder: |
1. Run...
2. Open...
3. Observe...
validations:
required: true

- type: input
id: php_version
attributes:
label: PHP version
description: Run php --version to find your version.
placeholder: PHP 8.2.0
validations:
required: true

- type: input
id: package_version
attributes:
label: Package version
description: Enter the affected Webisters package or application version.
placeholder: 1.0.0
validations:
required: true

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

- type: textarea
id: error_output
attributes:
label: Error output
description: Paste relevant error messages or logs.
render: shell

- type: textarea
id: extra_context
attributes:
label: Extra context
description: Add any other information that may help diagnose the problem.
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: Webisters Forum
url: https://github.com/webisters/forum
about: Ask questions and discuss ideas with the Webisters community.
- name: Webisters Documentation
url: https://webisters.com
about: Read the Webisters documentation and guides.
- name: Security Policy
url: https://github.com/webisters/app/blob/main/SECURITY.md
about: Report security vulnerabilities privately by following the security policy.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Documentation improvement
description: Report missing, unclear, or incorrect documentation
title: "[Docs]: "
labels:
- documentation
body:
- type: input
id: location
attributes:
label: Documentation location
description: Provide the page, file, section, or URL that needs improvement.
placeholder: README.md, installation section
validations:
required: true

- type: textarea
id: what_is_wrong
attributes:
label: What is wrong?
description: Explain what is missing, unclear, outdated, or incorrect.
placeholder: Describe the documentation problem.
validations:
required: true

- type: textarea
id: suggested_wording
attributes:
label: Suggested wording
description: Provide replacement or additional wording if you have it.

- type: checkboxes
id: willing_to_pr
attributes:
label: Contribution
options:
- label: I am willing to submit a pull request for this improvement.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature request
description: Suggest an improvement or new capability
title: "[Feature]: "
labels:
- enhancement
body:
- type: textarea
id: problem
attributes:
label: Problem or use case
description: Describe the problem this feature would solve.
placeholder: Explain who needs this feature and why.
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: Describe how you think the problem should be solved.
placeholder: Explain your proposed approach.
validations:
required: true

- type: dropdown
id: backwards_compatibility
attributes:
label: Could this break backwards compatibility?
description: Consider existing public APIs and user workflows.
options:
- "No"
- "Yes"
- Not sure
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe other solutions or workarounds you considered.

- type: checkboxes
id: willing_to_pr
attributes:
label: Contribution
options:
- label: I am willing to submit a pull request for this feature.
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Summary

<!-- Describe what this pull request changes and why. -->

## Related issue

Closes #

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Refactoring
- [ ] Tests
- [ ] Other

## Checklist

- [ ] I have read `CONTRIBUTING.md`
- [ ] `vendor/bin/phpunit` passes
- [ ] `vendor/bin/php-cs-fixer fix --dry-run --diff` reports no issues
- [ ] Tests have been added or updated where appropriate
- [ ] Documentation has been updated where appropriate
- [ ] Backwards compatibility has been preserved

## Backwards compatibility notes

<!-- Describe any public API impact or state that there is no impact. -->
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized 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

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

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

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

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

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

Thank you for contributing to Webisters. Contributions of all sizes are
welcome, including bug reports, feature suggestions, documentation
improvements, tests, and code changes.

## Ways to contribute

You can contribute by:

- Reporting reproducible bugs
- Suggesting features or improvements
- Improving documentation
- Adding or improving tests
- Fixing approved issues
- Reviewing open pull requests

Before starting work, comment on the relevant issue and wait for a maintainer
to assign it to you. This avoids duplicated effort and confirms that the
proposed approach fits the project.

## Security issues

Do not report security vulnerabilities through a public GitHub issue.

Follow [SECURITY.md](SECURITY.md) and report vulnerabilities privately to
thewebisters@gmail.com.

## Requirements

The development environment requires:

- PHP 8.2 or later
- Composer 2.x
- MariaDB or MySQL for database tests
- PHP extensions: `intl`, `sodium`, `gd`, `json`, `fileinfo`, `curl`,
`mysqli`, `simplexml`, `dom`, and `libxml`

## Setup

Run all commands from the repository root.

Install the dependencies:

```shell
composer install
Loading