Contributing
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
If you encounter a bug or have an enhancement suggestion, please check the "Issues" section of our GitHub repository or visit our official website for guidance before beginning any work on it.
I am excited that you're considering contributing to our project! Here are some guidelines to help you get started.
We primarily accept security fixes and critical patches to maintain project stability and coherence. Feature updates are not accepted to preserve our backend architecture and overall project integrity.
Below is an example of how to contribute to this GitHub project. Please follow this guideline and all other contribution rules carefully; otherwise, your request may be denied.
- Fork the repository to create your own copy.
- Create a new branch for your changes (e.g., feature/my-feature).
- Make your changes and verify everything works correctly.
- Commit your changes with clear and concise messages.
- Push your branch to your forked repository.
- Open a pull request to the main repository’s main branch with a detailed description of your changes.
- Reference any related issues or discussions in your pull request.
To ensure your implementation is effective and maintainable by other developers, please follow the code quality guidelines outlined below.
- Keep your code clean and well-organized.
- Add comments to explain complex logic or functions.
- Use meaningful and consistent variable and function names.
- Break down code into smaller, reusable functions and components.
- Follow proper indentation and formatting practices.
- Avoid code duplication by reusing existing functions or modules.
- Ensure your code is easily readable and maintainable by others.
If you encounter a bug or have an enhancement suggestion, please check the "Issues" section of our GitHub repository or visit our official website for guidance before beginning any work on it.