Skip to content

Commit 6466b9b

Browse files
committed
Add CONTRIBUTING.md and SECURITY.md files with guidelines for contributions and vulnerability reporting
1 parent a1d16ff commit 6466b9b

3 files changed

Lines changed: 76 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to TypePHP
2+
3+
Thank you for showing interest in contributing to this TypePHP library! Contributions are essential for building a robust type-safe ecosystem for the PHP community.
4+
5+
This library is designed to be a reliable foundation for high-performance applications. To achieve this, it maintains rigorous standards for code quality and developer experience.
6+
7+
## Development Workflow
8+
9+
To ensure consistency across the ecosystem, this repository requires the following workflow:
10+
11+
1. **Fork and Branch**: Fork the repository and create a feature branch from `main`.
12+
2. **Dependencies**: Install development tools using `composer install`.
13+
3. **Coding Standards**: This project follows strict PSR-12 standards. Use Laravel Pint to format code: `./vendor/bin/pint`.
14+
4. **Static Analysis**: Code must be predictable and type-safe. It must pass PHPStan at the maximum level: `./vendor/bin/phpstan analyse`.
15+
5. **Testing**: This project uses Pest. Ensure the test suite passes completely: `./vendor/bin/pest`.
16+
6. **Strict Typing**: Every PHP file must begin with `declare(strict_types=1);`.
17+
18+
19+
## Pull Request Process
20+
21+
1. **Start with an Issue**: Before writing code, please open an issue to discuss the bug or the proposed feature.
22+
2. **Tests are Required**: Every Pull Request must include automated tests that cover the new logic or prevent the bug from recurring.
23+
24+
---
25+
26+
The Hibla ecosystem thanks you for your time and effort!

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Reymart Calicdan <reymart.calicdan06@gmail.com>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

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+
This Hibla library takes the security of its users and their data seriously.
4+
5+
## Supported Versions
6+
7+
During the Alpha and Beta development phases, security updates are provided for the latest release only.
8+
9+
| Version | Supported |
10+
| ------- | ------------------ |
11+
| 1.0.x | :white_check_mark: |
12+
| < 1.0 | :x: |
13+
14+
## Reporting a Vulnerability
15+
16+
If a security vulnerability is discovered within this library, please report it privately to ensure the safety of all users.
17+
18+
Reports should be sent via e-mail to **Reymart A. Calicdan** at **reymart.calicdan06@gmail.com**.
19+
20+
**Please do not use public GitHub issues to report security vulnerabilities.**
21+
22+
### The Response Process
23+
24+
1. **Acknowledgment**: A response acknowledging the report will be sent within 48 hours.
25+
2. **Investigation**: The vulnerability will be investigated and confirmed in a private environment.
26+
3. **Resolution**: Once a fix is developed, it will be review and tested before being tagged in a new release.
27+
4. **Disclosure**: After the fix is public, credit will be given to the reporter for their contribution to the security of the Hibla ecosystem (unless anonymity is requested).
28+
29+
Thank you for helping keep Hibla secure for everyone.

0 commit comments

Comments
 (0)