同步操作将从 OpenTiny/ tiny-vue 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
We are glad that you are willing to contribute to the TinyVue open source project. There are many forms of contribution, and you can choose one or more of them according to your strengths and interests:
opentiny-official
and join the technical exchange group to participate in the discussion.When you personally use the TinyVue component library and participate in many of the above contributions, as you become familiar with TinyVue, you can try to do something more challenging, such as:
If you encounter problems in the process of using TinyVue components, you are welcome to submit Issue to us. Before submitting Issue, please read the relevant official documentation carefully to confirm whether this is a defect or an unimplemented function.
If it is a defect, select Bug report template when creating a new Issue. The title follows the format of [componentName] defect description
. For example: [select] filtering function, the selected option cannot be selected again after it has been deleted
.
Issue that reports defects mainly needs to fill in the following information:
@opentiny/vue
and vue
.If it is a new feature, select Feature request template. The title follows the format of [componentName] new feature description
. For example: [select] selection box is too long to display, hope to support the configuration of tips prompt
.
The following information is required for the Issue of the new feature:
Before submitting pull request, please make sure that your submission is in line with the overall plan of TinyVue. Generally, issues that marked as bug are encouraged to submit pull requests. If you are not sure, you can create a Discussion for discussion.
The commit message should be in the form of a type(scope): description of the message
, e.g. fix(vue-renderless): [scrollbar, action-menu] fix xxx bug
.
type: must be one of build, chore, ci, docs, feat, fix, perf, refactor, revert, release, style, test, improvement.
scope.
packages
directory, e.g. vue-design-aurora, vue-design-saas, react ......
packages
directory, e.g., vue-design-aurora/alert, vue-design-saas/alert, react/alert ......
gulp, internals/playwright-config, sites
action-menu, alert ......
The specification of the title is the same as the commit information, which is entered in the form of type(scope): description information
.
e2e test of trigger components: Adding '[componentName1, componentName2]' to the Pull Request title will execute test cases for componentName1, componentName2, and declare this structure when changes to code affect components.
Note: The github action
in this project identifies test e2e use cases to be executed by matching the component names declared by [componentName1, componentName2]
with the path names in the examples/sites/demos
directory. (Because running the full test case is too time consuming)
When modifying a sub-component of a component, such as the col
component, which has no corresponding examples and test cases, the layout
component should be tested, because the col
component is a sub-component of the layout
component. The PR title can be: fix(col): [layout] xxxxxxxxxxxxxx
Example title:
docs(alert): [alert] xxxxxxxxxxxxxxx
, docs(site): [alert] xxxxxxxxxxxxxxx
test(alert): [alert] xxxxxxxxxxxxxx
fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx
The PR description uses a template, and it is necessary to fill in the relevant information of the PR according to the template, mainly including:
pnpm i
under the TinyVue root directory to install node dependencies.pnpm dev
to launch the component library website.# You need to replace username with your own user name
git clone git@github.com:username/tiny-vue.git
cd tiny-vue
# Associate upstream repository
git remote add upstream git@github.com:opentiny/tiny-vue.git
# Installation
pnpm i
# Launch Vue.js 3
pnpm dev
# Launch Vue.js 2
pnpm dev:vue2
git pull upstream dev
.git checkout-b username/feature1 upstream/ dev
from the upstream repository dev branch. The name of the branch should be username/feat- xxx
/ username/fix- xxx
.git push origin branchName
.The contribution process is over, thank you for your contribution!
If you are interested in our open source project, you are welcome to join our open source community in the following ways.
If you have submitted Issue or PR to OpenTiny, you can comment on Issue or Pull Request, asking @all-contributors to add a contributor:
@all-contributors please add @<username> for <contributions>
For detailed rules, please refer to https://allcontributors.org/docs/en/bot/usage
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。