From 40772c258623a8788cf390a3385efb145c156f18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yueming=20Fang=20=28=E6=96=B9=E8=B7=83=E6=98=8E=29?= Date: Fri, 8 Dec 2023 18:47:22 +0800 Subject: [PATCH] fix(docs): Update form-button-group.md api table (#37) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: Update form-button-group.md api table * fix(ci): chagne branch master to main --------- Co-authored-by: 方跃明 --- .github/CONTRIBUTING.md | 11 ++++++----- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/check-pr-title.yml | 2 +- .github/workflows/ci.yml | 4 ++-- .github/workflows/commitlint.yml | 4 ++-- README.md | 2 +- README.zh-CN.md | 2 +- docs/guide/form-button-group.md | 10 +++++----- 8 files changed, 19 insertions(+), 18 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bb9c570..d53d6da 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,9 +2,10 @@ Hi! I’m really excited that you are interested in contributing to Formily. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines. -- [Issue Reporting Guidelines](#issue-reporting-guidelines) -- [Pull Request Guidelines](#pull-request-guidelines) -- [Git Commit Specific](./GIT_COMMIT_SPECIFIC.md) +- [Contributing Guide](#contributing-guide) + - [Issue Reporting Guidelines](#issue-reporting-guidelines) + - [Pull Request Guidelines](#pull-request-guidelines) + - [Git Commit Specific](#git-commit-specific) ## Issue Reporting Guidelines @@ -26,8 +27,8 @@ Hi! I’m really excited that you are interested in contributing to Formily. Bef ## Pull Request Guidelines -- Only code that's ready for release should be committed to the master branch. All development should be done in dedicated branches. -- Checkout a **new** topic branch from master branch, and merge back against master branch. +- Only code that's ready for release should be committed to the main branch. All development should be done in dedicated branches. +- Checkout a **new** topic branch from main branch, and merge back against main branch. - Work in the `src` folder and **DO NOT** checkin `dist` in the commits. - Make sure `npm test` passes. - If adding new feature: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e2c6f8b..1b79b4c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ _Before_ submitting a pull request, please make sure the following is done... - [ ] Ensure the pull request title and commit message follow the [Commit Specific](https://github.com/alibaba/formily/blob/formily_next/.github/GIT_COMMIT_SPECIFIC.md) in **English**. -- [ ] Fork the repo and create your branch from `master` or `formily_next`. +- [ ] Fork the repo and create your branch from `main` or `formily_next`. - [ ] If you've added code that should be tested, add tests! - [ ] If you've changed APIs, update the documentation. - [ ] Ensure the test suite passes (`npm test`). diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml index ed36fef..56c0ea6 100644 --- a/.github/workflows/check-pr-title.yml +++ b/.github/workflows/check-pr-title.yml @@ -11,7 +11,7 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: aslafy-z/conventional-pr-title-action@master + - uses: aslafy-z/conventional-pr-title-action@main with: preset: conventional-changelog-angular@^5.0.6 env: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8ae4ead..ee53779 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,10 +3,10 @@ name: Node CI on: push: branches: - - master + - main pull_request: branches: - - master + - main jobs: build: diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml index be68c23..7ab5c0c 100644 --- a/.github/workflows/commitlint.yml +++ b/.github/workflows/commitlint.yml @@ -6,9 +6,9 @@ name: Check Commit spec on: # Triggers the workflow on push or pull request events but only for the formily_next branch push: - branches: [master] + branches: [main] pull_request: - branches: [master] + branches: [main] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: diff --git a/README.md b/README.md index 5f28108..69becfc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ English | [简体中文](./README.zh-CN.md) - + PRs Welcome diff --git a/README.zh-CN.md b/README.zh-CN.md index f8445ed..d135f0d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -6,7 +6,7 @@ - + PRs Welcome diff --git a/docs/guide/form-button-group.md b/docs/guide/form-button-group.md index bd8648c..277a115 100644 --- a/docs/guide/form-button-group.md +++ b/docs/guide/form-button-group.md @@ -8,8 +8,8 @@ ## API -| 属性名 | 类型 | 描述 | 默认值 | -| ------------- | ------- | ------------- | -------- | -------- | -------- | -| gutter | number | 间隙大小 | 8px | -| align | `'left' | 'center' | 'right'` | 对齐方式 | `'left'` | -| alignFormItem | boolean | 对齐 FormItem | `false` | +| 属性名 | 类型 | 描述 | 默认值 | +| ------------- | ------- | ----------------------------------- | -------- | +| gutter | number | 间隙大小 | 8px | +| align | string | 对齐方式：`'left'/'center'/'right'` | `'left'` | +| alignFormItem | boolean | 对齐 FormItem | `false` |