Thank you for considering contributing to our open source project! Taking a moment to review this document will not only streamline the contribution process but also foster a collaborative and effective environment for everyone involved.
Adhering to these guidelines demonstrates your respect for the time and effort invested by the developers who manage and contribute to this project. By following these recommendations, you contribute to a smoother collaboration, and in return, you can expect the same level of respect when your issues are addressed or your patches and features are assessed.
Please use the repository discussion forum to ask your questions or discuss with other contributors on different subjects or questions around kaytu project.
If you believe you have found any issue or defect in the project or the documentations, please make a new issue in the issues section. You can first start a discussion in the discussion forum if you are not sure about the issue, or you have doubts in it.
If you have a new idea for a feature or modifications in the project, you can create a proposal in the issues section. Please do not submit a pull request until the project lead accepts the proposal.
I you are looking to get started committing to the project, we suggest you to look into the issues and find an easy one to start. We suggest you to submit a draft pull request so we can review your changes and discuss them before it is fully completed.
When you think the changes are ready to be merged to the project, you can create a pull request.
It may take a while for the core maintainer team to completely review the pull request, so we will appreciate if you make our job easier to do so. Here are some things which can help us:
- Write a clean code.
- Write helpful comments in the code.
- Write helpful and short comments in the pull request.
- Try to only make one change per pull request.