Skip to content

Commit 23a9966

Browse files
committed
fix(stylelint): prettify and ignore markdownlint extension
1 parent 2540fa7 commit 23a9966

File tree

4 files changed

+33
-32
lines changed

4 files changed

+33
-32
lines changed

.gitlab/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ There are some useful `MR, Issue, Test Plan` description templates collected fro
66

77
It's used when create new `issue`, now we only provide 4:
88

9-
- [Bug.md](./issue_template/Bug.md)
10-
- [Feature.md](./issue_template/Feature.md)
11-
- [Refactoring.md](./issue_template/Refactoring.md)
12-
- [Test.md](./issue_template/Test.md)
9+
- [Bug.md](./issue_template/Bug.md)
10+
- [Feature.md](./issue_template/Feature.md)
11+
- [Refactoring.md](./issue_template/Refactoring.md)
12+
- [Test.md](./issue_template/Test.md)
1313

1414
## MR Template
1515

1616
It's used when create new `Merge Request`.
1717

18-
- [Document.md](./issue_template/Document.md)
18+
- [Document.md](./issue_template/Document.md)
1919

2020
## More
2121

.gitlab/issue_templates/Test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ test plan](https://testing.googleblog.com/2011/09/10-minute-test-plan.html) and
3939
model](https://code.google.com/archive/p/test-analytics/wikis/AccExplained.wiki). -->
4040

4141
| | Secure | Responsive | Intuitive | Reliable |
42-
|------------|:------:|:----------:|:---------:|:--------:|
42+
| ---------- | :----: | :--------: | :-------: | :------: |
4343
| Admin | | | | |
4444
| Groups | | | | |
4545
| Project | | | | |

.gitlab/merge_request_templates/Document.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,51 @@ Link related issues below. Insert the issue link or reference after the word "Cl
1919

2020
## Author's checklist (required)
2121

22-
- [ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
23-
- If you have **Developer** permissions or higher:
24-
- [ ] Ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) is added to doc's `h1`.
25-
- [ ] Apply the ~documentation label, plus:
26-
- The corresponding DevOps stage and group labels, if applicable.
27-
- ~"development guidelines" when changing docs under `doc/development/*`, `CONTRIBUTING.md`, or `README.md`.
28-
- ~"development guidelines" and ~"Documentation guidelines" when changing docs under `development/documentation/*`.
29-
- ~"development guidelines" and ~"Description templates (.gitlab/\*)" when creating/updating issue and MR description templates.
30-
- [ ] Assign the [designated Technical Writer](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
22+
- [ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
23+
- If you have **Developer** permissions or higher:
24+
- [ ] Ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) is added to doc's `h1`.
25+
- [ ] Apply the ~documentation label, plus:
26+
- The corresponding DevOps stage and group labels, if applicable.
27+
- ~"development guidelines" when changing docs under `doc/development/*`, `CONTRIBUTING.md`, or `README.md`.
28+
- ~"development guidelines" and ~"Documentation guidelines" when changing docs under `development/documentation/*`.
29+
- ~"development guidelines" and ~"Description templates (.gitlab/\*)" when creating/updating issue and MR description templates.
30+
- [ ] Assign the [designated Technical Writer](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
3131

3232
Do not add the ~"feature", ~"frontend", ~"backend", ~"bug", or ~"database" labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
3333

3434
When applicable:
3535

36-
- [ ] Update the [permissions table](https://docs.gitlab.com/ee/user/permissions.html).
37-
- [ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
38-
- [ ] Add the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) accordingly.
39-
- [ ] Add [GitLab's version history note(s)](https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text).
40-
- [ ] Add/update the [feature flag section](https://docs.gitlab.com/ee/development/documentation/feature_flags.html).
36+
- [ ] Update the [permissions table](https://docs.gitlab.com/ee/user/permissions.html).
37+
- [ ] Link docs to and from the higher-level index page, plus other related docs where helpful.
38+
- [ ] Add the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges) accordingly.
39+
- [ ] Add [GitLab's version history note(s)](https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text).
40+
- [ ] Add/update the [feature flag section](https://docs.gitlab.com/ee/development/documentation/feature_flags.html).
4141

4242
## Review checklist
4343

4444
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
4545

46-
**1. Primary Reviewer**
46+
1. **Primary Reviewer**
4747

48-
* [ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
48+
- [ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
4949

5050
**2. Technical Writer**
5151

52-
- [ ] Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages).
53-
- [ ] Ensure docs metadata are present and up-to-date.
54-
- [ ] Ensure ~"Technical Writing" and ~"documentation" are added.
55-
- [ ] Add the corresponding `docs::` [scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=docs%3A%3A).
56-
- [ ] If working on UI text, add the corresponding `UI Text` [scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=ui+text).
57-
- [ ] Add ~"tw::doing" when starting work on the MR.
58-
- [ ] Add ~"tw::finished" if Technical Writing team work on the MR is complete but it remains open.
52+
- [ ] Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages).
53+
- [ ] Ensure docs metadata are present and up-to-date.
54+
- [ ] Ensure ~"Technical Writing" and ~"documentation" are added.
55+
- [ ] Add the corresponding `docs::` [scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=docs%3A%3A).
56+
- [ ] If working on UI text, add the corresponding `UI Text` [scoped label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=ui+text).
57+
- [ ] Add ~"tw::doing" when starting work on the MR.
58+
- [ ] Add ~"tw::finished" if Technical Writing team work on the MR is complete but it remains open.
5959

6060
For more information about labels, see [Technical Writing workflows - Labels](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#labels).
6161

6262
For suggestions that you are confident don't need to be reviewed, change them locally
6363
and push a commit directly to save others from unneeded reviews. For example:
6464

65-
- Clear typos, like `this is a typpo`.
66-
- Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
65+
- Clear typos, like `this is a typpo`.
66+
- Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
6767

6868
For more information, see our documentation on [Merging a merge request](https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request).
6969

.vscode/settings.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66
"source.fixAll.eslint": true,
77
"source.fixAll.markdownlint": false,
88
"source.fixAll.stylelint": true
9-
}
9+
},
10+
"markdownlint.ignore": ["**/*.md"]
1011
}

0 commit comments

Comments
 (0)