64 lines
1.3 KiB
Markdown
64 lines
1.3 KiB
Markdown
# Contributing to Evercatch
|
|
|
|
Thank you for contributing. Please read this guide before opening issues or PRs.
|
|
|
|
---
|
|
|
|
## 🌿 Branching
|
|
|
|
Branch from `main` using the format `EC-ID-short-description`.
|
|
|
|
```bash
|
|
git checkout -b EC-12-implement-stripe-inbound
|
|
```
|
|
|
|
---
|
|
|
|
## ✨ Commit Messages
|
|
|
|
Follow the Conventional Commits standard prefixed with the issue ID.
|
|
|
|
**Format:** `EC-00: <type>(scope): message`
|
|
|
|
| Type | Description |
|
|
| :--- | :--- |
|
|
| `feat` | New feature |
|
|
| `fix` | Bug fix |
|
|
| `docs` | Documentation |
|
|
| `style` | Formatting |
|
|
| `refactor` | Refactor |
|
|
| `perf` | Performance |
|
|
| `test` | Tests |
|
|
| `build` | Build system |
|
|
| `ci` | CI/CD config |
|
|
| `chore` | Maintenance |
|
|
|
|
**Examples:**
|
|
- `EC-12: feat(webhooks): implement stripe inbound endpoint`
|
|
- `EC-18: fix(relay): resolve double-delivery on retry`
|
|
|
|
---
|
|
|
|
## 🔍 Pull Requests
|
|
|
|
- Link the issue in your PR description
|
|
- All CI checks must pass before requesting review
|
|
- Minimum one approval required to merge
|
|
- Keep PRs focused — one feature or fix per PR
|
|
|
|
---
|
|
|
|
## 🏷️ Labels
|
|
|
|
Apply the appropriate labels to your issue or PR:
|
|
|
|
- `type:` — what kind of change is this
|
|
- `priority:` — how urgent is it
|
|
- `status:` — current state of the issue or PR
|
|
|
|
---
|
|
|
|
## ❓ Questions
|
|
|
|
Open an issue with the `type: chore` label or reach out via the org README.
|