Developper Guide
Last updated on
Useful links
API Endpoints
Frontend
Backend
Cli
How to Contribute
- Fork the repository and create your branch from
main. - Execute the command
task init, it will setup the hook of env and other useful tools. - Make your changes, ensuring that you follow the project's coding standards (e.g., formatting, naming conventions) it will be checked automatically with
task lintand in the future a more thorough CI process. - Explain your changes in a clear and concise manner in the commit messages.
- Push your changes to your fork and open a pull request against the
mainbranch. - Fill out the pull request template with relevant details about your changes.
IA and stance on it
ProxyAuthK8s has been developed with the help of AI tools like Github Copilot BUT no Business logic or critical code has been generated by AI. The use of "generative" AI has been limited to helping create the UI components and making sure i wasn't too much off track syncing components together (It happened a lot and i made lots of mistakes in the process). The core logic of the project has been developed by myself with minimal help from AI tools (mostly on completing my current line of code and not generating new code from scratch).
ALL PR must be reviewed by a human and the use of AI tools must be disclosed in the PR description. The use of AI tools is allowed but it should not be used to generate critical code or business logic without human review and validation. The final responsibility for the code quality and correctness lies with the human developers, not the AI tools. If a PR is not backed by a human review, it will be rejected regardless of the quality of the code or the use of AI tools in its creation. The use of AI tools should be seen as a way to assist and enhance human development, not replace it. (AND YES I JUDGE THE CODER TOO !)
Have feedback?
Share on GitHub