Thanks for your interest in contributing to the Phone Theft Tracking System! This document outlines how to get set up and submit changes.
- Fork the repository and clone your fork locally.
- Follow the setup instructions in the README to get the backend and frontend running locally.
- Create a new branch for your work:
git checkout -b feature/short-description- Keep pull requests focused on a single feature or fix — smaller PRs are easier to review.
- Follow the existing code style in the file you're editing (the frontend uses ESLint; run pm run lint in rontend/ before submitting).
- Add comments for any non-obvious logic, especially around the ownership-transfer and certificate-issuance flows.
- If you change the Prisma schema, include the generated migration in your PR.
We loosely follow Conventional Commits:
feat: add vendor tier upgrade endpoint
fix: correct risk score calculation for INVESTIGATING devices
docs: update API setup instructions
- Push your branch to your fork:
git push origin feature/short-description- Open a Pull Request against main.
- Describe what changed and why — link any related issue.
- Be ready to respond to review feedback; we aim to review PRs within a few days.
- Search existing issues before opening a new one.
- For bugs, include: steps to reproduce, expected vs. actual behavior, and relevant logs/screenshots.
- For feature requests, explain the use case — see ROADMAP.md for planned directions, your idea might already be on there.
Please do not open a public issue for security vulnerabilities. See SECURITY.md for responsible disclosure steps.
This project follows our Code of Conduct. Please be respectful and constructive in all interactions.
Thank you for helping make PTS better! 🙌