Contribution Guide

Thank you for your interest in contributing to SeeYouUI. Please take a few minutes to read through this guide before submitting an Issue or a Pull Request.

Branch Management

We maintain three long-term branches: master, feature, and dev. If you want to fix a bug, please submit a Pull Request to the dev branch. If you want to propose a new feature, please do so based on the feature branch. At the end of each month, we merge feature into master and publish to Dcloud and npm.

New Features

If you have ideas for improving our existing components or adding new ones, please create a "New Feature" Issue and develop it within the feature branch.

About Bugs

If you want a bug you've discovered to be resolved quickly, the best way is to submit an Issue. We will fix it as soon as possible.

Please ensure your bug is reproducible and provide as much code and as many screenshots as possible so that we can locate the problem faster.

If you have the capability, you can also submit a Pull Request directly to the dev branch, which can accelerate the fix process.

First-time Contribution

If you are not yet sure how to submit a Pull Request on GitHub, you can read the following article to learn: How to Gracefully Contribute Code on GitHub

Our Development Workflow

graph TD
  see-u-ui:main_commit --> GmhLovEDM_manual_review --> Publish_to_Dcloud
  see-u-ui:main_commit --> Auto_sync_to_see-u-ui-npm_repo --> GmhLovEDM_manual_review --> Publish_to_NPM --> Auto_update_see-u-ui-project_repo
  see-u-ui:main_commit --> Auto_sync_to_see-u-ui-cli_repo --> Auto_deploy_demo_project_to_seeuui.cn
  see-u-ui-doc:main_commit --> Auto_deploy_demo_project_to_seeuui.cn

  style Auto_sync_to_see-u-ui-cli_repo white-space:nowrap
  style Auto_sync_to_see-u-ui-npm_repo white-space:nowrap
  style Auto_update_see-u-ui-project_repo white-space:nowrap

Join the Community

If your contribution level is significant and you wish to participate in maintenance work alongside the SeeYouUI team, you can apply to become a community collaborator.

You can also learn about the current main collaborators in About Us.