Skip to content

Commit 626cb95

Browse files
author
Óscar J. Baeza
committed
docs: Add SECURITY, CODE_OF_CONDUCT, CONTRIBUTING, and LICENSE files.
1 parent 6f63f61 commit 626cb95

4 files changed

Lines changed: 196 additions & 0 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to making participation in this project a positive experience for everyone.
6+
7+
## Our Standards
8+
9+
**Expected behavior:**
10+
11+
- Be respectful and inclusive
12+
- Accept constructive feedback gracefully
13+
- Focus on what is best for the community
14+
- Show empathy towards others
15+
16+
**Unacceptable behavior:**
17+
18+
- Disrespectful or unprofessional conduct
19+
- Personal attacks or inflammatory comments
20+
- Publishing others' private information without permission
21+
22+
## Enforcement
23+
24+
Project maintainers may remove, edit, or reject contributions that do not align with this Code of Conduct.
25+
26+
Instances of unacceptable behavior may be reported via [GitHub Issues](https://github.com/ojbaeza/station-example/issues).
27+
28+
## Attribution
29+
30+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Contributing to Station Example
2+
3+
Thank you for your interest in contributing to the Station Example application! This document provides guidelines and instructions for contributing.
4+
5+
## Requirements
6+
7+
- **PHP 8.3+** (8.4 recommended)
8+
- **Laravel 12.x**
9+
- **Docker** (for development environment)
10+
11+
## Development Environment Setup
12+
13+
### 1. Clone and Install
14+
15+
```bash
16+
git clone https://github.com/ojbaeza/station-example.git
17+
cd station-example
18+
composer install
19+
```
20+
21+
### 2. Start Docker Services
22+
23+
```bash
24+
docker compose up -d
25+
```
26+
27+
### 3. Verify Setup
28+
29+
```bash
30+
docker exec station_example sh -c "XDEBUG_MODE=off php artisan test"
31+
```
32+
33+
## Code Style
34+
35+
This project follows **PER-CS 3.0** coding standards.
36+
37+
### Fixing Code Style
38+
39+
```bash
40+
composer cs-fix
41+
```
42+
43+
**Note:** Do not use Laravel Pint. Use `composer cs-fix` (PHP-CS-Fixer) instead.
44+
45+
## Static Analysis
46+
47+
Station Example uses **PHPStan at level 8** with Larastan for Laravel-specific rules.
48+
49+
```bash
50+
docker exec station_example sh -c "XDEBUG_MODE=off php vendor/bin/phpstan analyse --memory-limit=512M"
51+
```
52+
53+
## Testing
54+
55+
### Running Tests
56+
57+
```bash
58+
# All tests
59+
docker exec station_example sh -c "XDEBUG_MODE=off php artisan test"
60+
61+
# Specific test
62+
docker exec station_example sh -c "XDEBUG_MODE=off php artisan test --filter TestClassName"
63+
```
64+
65+
### Test Naming Convention
66+
67+
Use camelCase pattern: `test{Feature}{Scenario}{ExpectedResult}`
68+
69+
```php
70+
public function testDispatchWithValidJobReturnsJobId(): void
71+
public function testRecoveryWithStuckJobResumesSuccessfully(): void
72+
```
73+
74+
## Pull Request Process
75+
76+
### Before Submitting
77+
78+
1. **Create a feature branch** from `main`
79+
2. **Write tests** for your changes
80+
3. **Ensure all checks pass:**
81+
```bash
82+
composer cs-fix
83+
docker exec station_example sh -c "XDEBUG_MODE=off php vendor/bin/phpstan analyse --memory-limit=512M"
84+
docker exec station_example sh -c "XDEBUG_MODE=off php artisan test"
85+
```
86+
87+
### Submitting
88+
89+
1. Push your branch to your fork
90+
2. Open a Pull Request against `main`
91+
3. Wait for CI checks to pass
92+
93+
### PR Guidelines
94+
95+
- Keep PRs focused and reasonably sized
96+
- One feature or fix per PR
97+
- Write clear commit messages
98+
- Reference related issues
99+
100+
## Getting Help
101+
102+
- **Questions:** Open a GitHub Discussion
103+
- **Bug Reports:** Open a GitHub Issue with reproduction steps
104+
- **Station Package:** See [ojbaeza/station](https://github.com/ojbaeza/station)
105+
106+
## Code of Conduct
107+
108+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code.
109+
110+
## License
111+
112+
By contributing, you agree that your contributions will be licensed under the MIT License.

‎LICENSE‎

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 Óscar J. Baeza
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: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security Policy
2+
3+
## Important Notice
4+
5+
This is an **example application** intended for local development and demonstration purposes. It is **not designed for production deployment** without additional security hardening.
6+
7+
By default, all routes are unauthenticated. See the [Station package](https://github.com/ojbaeza/station) for production-ready authentication and security features.
8+
9+
## Reporting a Vulnerability
10+
11+
**Please do not report security vulnerabilities through public GitHub issues.**
12+
13+
Report vulnerabilities via [GitHub Security Advisories](https://github.com/ojbaeza/station-example/security/advisories):
14+
15+
1. Go to the Security Advisories page
16+
2. Click "Report a vulnerability"
17+
3. Provide a detailed description of the vulnerability
18+
19+
For vulnerabilities in the Station package itself, report to [ojbaeza/station](https://github.com/ojbaeza/station/security/advisories).
20+
21+
## What to Expect
22+
23+
- **Initial Response:** Within 48 hours
24+
- **Status Update:** Within 7 days
25+
- **Resolution Timeline:** Depends on severity
26+
27+
## Scope
28+
29+
This security policy applies to:
30+
31+
- The Station Example application (`ojbaeza/station-example`)
32+
33+
For the Station package security policy, see [ojbaeza/station SECURITY.md](https://github.com/ojbaeza/station/blob/main/SECURITY.md).

0 commit comments

Comments
 (0)