fix(docs): Update form-button-group.md api table (#37)

* fix: Update form-button-group.md api table * fix(ci): chagne branch master to main --------- Co-authored-by: 方跃明 <[email protected]>
formilyjs · Dec 8, 2023 · 40772c2 · 40772c2
1 parent 0c0ed3b
commit 40772c2
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 18 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -6,7 +6,7 @@ English | [简体中文](./README.zh-CN.md)
 <img src="https://img.shields.io/npm/dm/@formily/element-plus"/>
 <a href="https://www.npmjs.com/package/@formily/element-plus"><img src="https://img.shields.io/npm/v/@formily/element-plus.svg"></a>
 <a href="https://codecov.io/gh/formilyjs/element-plus">
-  <img src="https://codecov.io/gh/formilyjs/element-plus/branch/master/graph/badge.svg?token=3V9RU8Wh9d"/>
+  <img src="https://codecov.io/gh/formilyjs/element-plus/branch/main/graph/badge.svg?token=3V9RU8Wh9d"/>
 </a>
 <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/>
 <a href="https://github.com/actions-cool/issues-helper">

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -6,7 +6,7 @@
 <img src="https://img.shields.io/npm/dm/@formily/element-plus"/>
 <a href="https://www.npmjs.com/package/@formily/element-plus"><img src="https://img.shields.io/npm/v/@formily/element-plus.svg"></a>
 <a href="https://codecov.io/gh/formilyjs/element-plus">
-  <img src="https://codecov.io/gh/formilyjs/element-plus/branch/master/graph/badge.svg?token=3V9RU8Wh9d"/>
+  <img src="https://codecov.io/gh/formilyjs/element-plus/branch/main/graph/badge.svg?token=3V9RU8Wh9d"/>
 </a>
 <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/>
 <a href="https://github.com/actions-cool/issues-helper">

diff --git 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`  |