Contribution Guide

Build Open Source Together

Open source requires everyone's support. There are many ways to support it, such as using, recommending, writing tutorials, protecting the ecosystem, contributing code, answering questions, sharing experiences, etc. 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

• MineAdmin Backend Source Code
• MineAdmin Frontend Source Code

What You Can Do

Monitor Issues Activity

• We will publish features to be developed in issues. If you are interested, you can leave a comment in the issues, and we will reply as soon as possible.
• Reply to comments to help users who have questions.
• Based on the content of issues, propose reasonable solutions; fix bugs or implement features, and submit them to the MineAdmin repository as a pull request.
• Monitor the progress and status of your submitted Pull Request to facilitate its merger into the main repository as soon as possible.
• Perform Code Review on Pull Requests submitted by others and provide your suggestions and opinions.
• Develop independent functional components based on the needs of others or yourself.
• Improve the documentation to provide better usage instructions.

Pull Request Guide

Although we will periodically publish features to be developed, we welcome you to propose features you wish to implement. You can propose your ideas in issues, and we will reply as soon as possible regarding acceptance. Before submitting an issue, please check if a similar issue has already been published.

• Fork this repository to your Github account.
• The commit message format should be [File Name]: Info about commit. (e.g.) README.md: Fix xxx bug
• Before submitting code, first execute composer cs-fix to format the code.
• Before submitting code, first execute composer an to perform static code analysis.
• Before submitting code, first execute composer test to run unit tests. Do not run unit tests in any of your production environments, as they will delete and add data.
• Ensure the PR is created from your feature branch, rather than directly submitting modifications on the master branch.
• If your PR fixes a bug, please provide a description of the related bug.