Skip to content

Commit 077571c

Browse files
Add contributing guidelines and security policy documentation. (#9)
1 parent 21e3fb0 commit 077571c

3 files changed

Lines changed: 93 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to ui-awesome
2+
3+
Thank you for your interest in contributing. Please read this guide before submitting issues or pull requests.
4+
5+
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
6+
7+
## Development Environment
8+
9+
**Requirements:**
10+
11+
- PHP 8.3 or higher.
12+
- [Composer](https://getcomposer.org/) 2.x.
13+
14+
**Setup:**
15+
16+
```bash
17+
git clone https://github.com/ui-awesome/<repository>.git
18+
cd <repository>
19+
composer install
20+
composer run
21+
```
22+
23+
## Coding Standards
24+
25+
All PHP code must follow these standards:
26+
27+
- **PER 3.0 + PSR-12** coding style.
28+
- `declare(strict_types=1)` in every PHP file.
29+
- Strong typing: use type declarations for parameters, return types, and properties.
30+
- Use [php-forge/coding-standard](https://github.com/php-forge/coding-standard) for automated style checks.
31+
32+
## Testing
33+
34+
- All tests use **PHPUnit 12+**.
35+
- Target **100% code coverage** for new code.
36+
- Run the quality/test scripts defined in the target repository's `composer.json` before submitting a pull request
37+
(for example, `test`, `static`, `ecs`, `rector`, or `check-dependencies`):
38+
39+
```bash
40+
composer run
41+
```
42+
43+
## Pull Request Process
44+
45+
1. Fork the repository and create a feature branch from `main`.
46+
2. Make your changes in small, focused commits.
47+
3. Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
48+
4. One logical change per pull request.
49+
5. Ensure all tests pass and coding standards are met.
50+
6. Open a pull request against `main` with a clear description of the change.
51+
52+
## Security Vulnerabilities
53+
54+
Do not open public issues for security vulnerabilities. See [SECURITY.md](SECURITY.md) for reporting instructions.

PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Pull Request
22

3-
| Q | A |
4-
| ------------ | ------------------------------------------------------------------ |
5-
| Is bugfix? | ✔️/❌ |
6-
| New feature? | ✔️/❌ |
7-
| Breaks BC? | ✔️/❌ |
8-
| Fixed issues | <!-- comma-separated list of tickets # fixed by the PR, if any --> |
3+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
4+
- [ ] Bugfix (non-breaking change that fixes an issue)
5+
- [ ] CI/build configuration
6+
- [ ] Documentation update
7+
- [ ] New feature (non-breaking change that adds functionality)
8+
- [ ] Refactoring (no functional changes)
9+
10+
## Related Issues
11+
12+
<!-- Reference related issues: Fixes #123, Closes #456 -->

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
**Do not open a public issue for security vulnerabilities.**
6+
7+
Use the GitHub Security Advisories feature in the affected repository to report vulnerabilities privately:
8+
9+
1. Navigate to the affected repository (for example, `https://github.com/ui-awesome/repo-name`, replacing `repo-name`
10+
with the affected repository).
11+
2. Go to the **Security** tab.
12+
3. Click **Report a vulnerability**.
13+
4. Provide a detailed description including steps to reproduce, impact, and any suggested fix.
14+
15+
For more information, see [Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).
16+
17+
## Supported Versions
18+
19+
Security fixes are applied to the latest release of each package. Older versions do not receive security updates.
20+
21+
## Response Timeline
22+
23+
- **Acknowledgment**: Within 48 hours of the report.
24+
- **Assessment**: Within 7 days, an initial assessment and plan of action.
25+
- **Fix and disclosure**: A fix is developed, tested, and released before public disclosure.
26+
27+
## Scope
28+
29+
This policy applies to all repositories under the [ui-awesome](https://github.com/ui-awesome) organization.

0 commit comments

Comments
 (0)