|
| 1 | +# 🌱 Contributing |
| 2 | + |
| 3 | +I am excited that you're considering contributing to our project! Here are some guidelines to help you get started. |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +If you wish to extend functionality, please develop a custom extension module outside the core code and integrate it via the CMS system. |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +- Fork the repository to create your own copy. |
| 12 | +- Create a new branch for your changes (e.g., feature/my-feature). |
| 13 | +- Make your changes and verify everything works correctly. |
| 14 | +- Commit your changes with clear and concise messages. |
| 15 | +- Push your branch to your forked repository. |
| 16 | +- Open a pull request to the main repository’s main branch with a detailed description of your changes. |
| 17 | +- Reference any related issues or discussions in your pull request. |
| 18 | + |
| 19 | +To ensure your implementation is effective and maintainable by other developers, please follow the code quality guidelines outlined below. |
| 20 | + |
| 21 | +- Keep your code clean and well-organized. |
| 22 | +- Add comments to explain complex logic or functions. |
| 23 | +- Use meaningful and consistent variable and function names. |
| 24 | +- Break down code into smaller, reusable functions and components. |
| 25 | +- Follow proper indentation and formatting practices. |
| 26 | +- Avoid code duplication by reusing existing functions or modules. |
| 27 | +- Ensure your code is easily readable and maintainable by others. |
| 28 | + |
| 29 | +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. |
| 30 | + |
| 31 | +🐟 Bugfish |
0 commit comments