Are you an LLM? You can read better optimized documentation at /guide/contributions.md for this page in Markdown format
Contribution Guide β
Open Source Collaboration
Open source thrives on collective support, which can take many formsβusing the software, recommending it, writing tutorials, protecting the ecosystem, contributing code, answering questions, sharing experiences, and more. Welcome to join us!
Repository Addresses β
Please do not contribute to the Gitee repository. Code submitted to Gitee will be overwritten by the GitHub repository, and your name will not appear in the contributor list.
GitHub β
- MineAdmin Backend Source Code
- MineAdmin Frontend Source Code
- MineAdmin Core Components
- MineAdmin Documentation
Gitee β
What You Can Do β
Follow Issues Activity β
- We post upcoming features in Issues. If you're interested, leave a comment, and we'll respond promptly.
- Help users by answering their questions in the comments.
- Propose reasonable solutions based on the Issues content, fix bugs, or implement features, then submit them as a Pull Request to the MineAdmin repository.
- Track the progress and status of your submitted Pull Requests to ensure they are merged into the main repository as soon as possible.
- Review others' Pull Requests with constructive feedback and suggestions.
- Develop independent functional components based on your own or others' needs.
- Improve the documentation to provide better usage instructions.
Pull Request Guidelines β
While we periodically post features awaiting development, we highly encourage you to propose ideas you'd like to implement. You can share your thoughts in Issues, and we'll respond promptly on whether they'll be accepted.
Before submitting an issue, check if a similar one already exists.
- Fork this repository to your GitHub account.
- Commit messages should follow the format: [File Name]: Info about commit. (Example)
README.md: Fix xxx bug - Before submitting code, run
composer cs-fixto format your code. - Before submitting code, run
composer anfor static code analysis. - Before submitting code, run
composer testfor unit testing. Do not run unit tests in any production environment, as it will delete added data. - Ensure your PR is created from a feature branch, not directly from the
masterbranch. - If your PR fixes a bug, include a description of the related bug.