-
-
Notifications
You must be signed in to change notification settings - Fork 14
Contributing Guide
Jaeseok Song edited this page Jan 13, 2026
·
2 revisions
First off, thank you for considering contributing to Pingora Proxy Manager! It's people like you that make it a great tool for everyone.
Please be respectful and professional in all interactions.
- Check the Issues page to see if the bug has already been reported.
- If not, create a new issue. Include as much detail as possible: steps to reproduce, expected behavior, and actual behavior.
- Open an issue and label it as an
enhancement. - Describe the feature you'd like to see and why it would be useful.
- Fork the repository.
- Create a new branch for your feature or bugfix (
git checkout -b feature/awesome-feature). - Make your changes.
- Run tests (
cargo testfor backend). - Commit your changes (
git commit -m 'Add some awesome feature'). - Push to the branch (
git push origin feature/awesome-feature). - Open a Pull Request.
- Follow standard Rust naming conventions (
snake_casefor variables/functions,PascalCasefor types). - Use
cargo fmtto format your code. - Write doc comments for public functions.
- Keep functions small and focused.
- Use functional components and hooks.
- Use Tailwind CSS for styling.
- Follow the existing component structure in
frontend/src/components.
- Every PR will trigger a GitHub Action to build the backend and frontend.
- Ensure the build passes before asking for a review.
Thank you for your contribution!