Open Source Guide
Contributing to LaraPost
Keep PRs focused, tested, and documented. This package is used in production apps and changes should be safe, reviewable, and easy to release.
Contribution Model
External contributions must be submitted from a fork. Direct contribution branches in the upstream repository are reserved for maintainers.
- Fork
prateekbhujel/larapostto your account. - Create your branch in your fork and open a PR to
main. - Keep your fork updated with upstream before opening a PR.
Ground Rules
- Keep each change focused to one behavior or fix.
- Add or update tests for behavior changes.
- Do not commit secrets, API keys, or credentials.
- Document user-facing changes in README/docs/changelog.
Local Setup
git clone https://github.com/prateekbhujel/larapost.git
cd larapost
composer install
composer testBranch Naming
Use clear, purpose-driven branch names:
feature/oauth-state-validationfix/linkedin-media-errordocs/release-checklist
Pull Request Checklist
- Tests pass locally (`composer test`).
- Public API/config impacts are documented.
- README/docs updated if behavior changed.
- Changelog updated for notable user-facing changes.
Commit Style
Use concise conventional commits where possible:
feat: add retry backoff override per provider
fix: prevent duplicate claim in scheduled runner
docs: clarify production cron requirementsIssue Reports
Include:
- Package version and Laravel version
- PHP version and environment details
- Exact error and stack trace
- Minimal reproduction steps