Skip to content

Commit a94d2cd

Browse files
authored
[add] GitHub repository settings & PR badges (#28)
1 parent 28b30a1 commit a94d2cd

File tree

11 files changed

+708
-462
lines changed

11 files changed

+708
-462
lines changed

.github/pr-badge.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
- icon: visualstudio
2+
label: 'GitHub.dev'
3+
message: 'PR-$prNumber'
4+
color: 'blue'
5+
url: 'https://github.dev/$owner/$repo/pull/$prNumber'
6+
7+
- icon: github
8+
label: 'GitHub codespaces'
9+
message: 'PR-$prNumber'
10+
color: 'black'
11+
url: 'https://codespaces.new/$owner/$repo/pull/$prNumber'
12+
13+
- icon: git
14+
label: 'GitPod.io'
15+
message: 'PR-$prNumber'
16+
color: 'orange'
17+
url: 'https://gitpod.io/?autostart=true#https://github.com/$owner/$repo/pull/$prNumber'

.github/settings.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# These settings are synced to GitHub by https://probot.github.io/apps/settings/
2+
3+
repository:
4+
allow_merge_commit: false
5+
6+
delete_branch_on_merge: true
7+
8+
enable_vulnerability_alerts: true
9+
10+
labels:
11+
- name: bug
12+
color: '#d73a4a'
13+
description: Something isn't working
14+
15+
- name: documentation
16+
color: '#0075ca'
17+
description: Improvements or additions to documentation
18+
19+
- name: duplicate
20+
color: '#cfd3d7'
21+
description: This issue or pull request already exists
22+
23+
- name: enhancement
24+
color: '#a2eeef'
25+
description: Some improvements
26+
27+
- name: feature
28+
color: '#16b33f'
29+
description: New feature or request
30+
31+
- name: good first issue
32+
color: '#7057ff'
33+
description: Good for newcomers
34+
35+
- name: help wanted
36+
color: '#008672'
37+
description: Extra attention is needed
38+
39+
- name: invalid
40+
color: '#e4e669'
41+
description: This doesn't seem right
42+
43+
- name: question
44+
color: '#d876e3'
45+
description: Further information is requested
46+
47+
- name: wontfix
48+
color: '#ffffff'
49+
description: This will not be worked on
50+
51+
branches:
52+
- name: main
53+
# https://docs.github.com/en/rest/reference/repos#update-branch-protection
54+
protection:
55+
# Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
56+
required_pull_request_reviews:
57+
# The number of approvals required. (1-6)
58+
required_approving_review_count: 1
59+
# Dismiss approved reviews automatically when a new commit is pushed.
60+
dismiss_stale_reviews: true
61+
# Blocks merge until code owners have reviewed.
62+
require_code_owner_reviews: true
63+
# Specify which users and teams can dismiss pull request reviews.
64+
# Pass an empty dismissal_restrictions object to disable.
65+
# User and team dismissal_restrictions are only available for organization-owned repositories.
66+
# Omit this parameter for personal repositories.
67+
dismissal_restrictions:
68+
# users: []
69+
# teams: []
70+
# Required. Require status checks to pass before merging. Set to null to disable
71+
required_status_checks:
72+
# Required. Require branches to be up to date before merging.
73+
strict: true
74+
# Required. The list of status checks to require in order to merge into this branch
75+
contexts: []
76+
# Required. Enforce all configured restrictions for administrators.
77+
# Set to true to enforce required status checks for repository administrators.
78+
# Set to null to disable.
79+
enforce_admins: true
80+
# Prevent merge commits from being pushed to matching branches
81+
required_linear_history: true
82+
# Required. Restrict who can push to this branch.
83+
# Team and user restrictions are only available for organization-owned repositories.
84+
# Set to null to disable.
85+
restrictions: null

.gitpod.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# This configuration file was automatically generated by Gitpod.
2+
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
3+
# and commit this file to your remote git repository to share the goodness with others.
4+
5+
# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
6+
7+
vscode:
8+
extensions:
9+
- yzhang.markdown-all-in-one
10+
- redhat.vscode-yaml
11+
- akamud.vscode-caniuse
12+
- visualstudioexptteam.intellicode-api-usage-examples
13+
- pflannery.vscode-versionlens
14+
- christian-kohler.npm-intellisense
15+
- esbenp.prettier-vscode
16+
- eamodio.gitlens
17+
- github.vscode-pull-request-github
18+
- github.vscode-github-actions
19+
tasks:
20+
- init: pnpm i
21+
command: npm test

.vscode/extensions.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"recommendations": [
3+
"yzhang.markdown-all-in-one",
4+
"redhat.vscode-yaml",
5+
"akamud.vscode-caniuse",
6+
"visualstudioexptteam.intellicode-api-usage-examples",
7+
"pflannery.vscode-versionlens",
8+
"christian-kohler.npm-intellisense",
9+
"esbenp.prettier-vscode",
10+
"eamodio.gitlens",
11+
"github.vscode-pull-request-github",
12+
"github.vscode-github-actions"
13+
]
14+
}

ReadMe-zh.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ export class MyButton extends HTMLElement {
283283
<>
284284
<link
285285
rel="stylesheet"
286-
href="https://unpkg.com/[email protected].2/dist/css/bootstrap.min.css"
286+
href="https://unpkg.com/[email protected].3/dist/css/bootstrap.min.css"
287287
/>
288288
<a className="btn">
289289
<slot />
@@ -477,7 +477,7 @@ new DOMRenderer().render(
477477
### 工具链
478478

479479
```shell
480-
npm install jsdom element-internals-polyfill
480+
npm install jsdom
481481
```
482482

483483
### Polyfill
@@ -486,34 +486,40 @@ npm install jsdom element-internals-polyfill
486486
import 'web-cell/polyfill';
487487
```
488488

489+
### 服务端渲染
490+
491+
https://github.com/EasyWebApp/DOM-Renderer?tab=readme-ov-file#nodejs--bun
492+
489493
## 基础知识
490494

491495
- [Web 组件][23]
492496
- [自定义元素][24]
493497
- [虚拟 DOM][25]
494498
- [Element Internals][26]
495499
- [CSS 变量][27]
496-
- [ECMAScript 6+][28]
500+
- [视图渐变][28]
501+
- [ECMAScript 6+][29]
497502
- [TypeScript 5+][4]
498503

499504
## 生命周期钩子
500505

501-
1. [`connectedCallback`][30]
502-
2. [`disconnectedCallback`][31]
503-
3. [`attributeChangedCallback`][32]
504-
4. [`adoptedCallback`][33]
505-
5. [`updatedCallback`][34]
506-
6. [`mountedCallback`][35]
507-
7. [`formAssociatedCallback`][36]
508-
8. [`formDisabledCallback`][37]
509-
9. [`formResetCallback`][38]
506+
1. [`connectedCallback`][30]
507+
2. [`disconnectedCallback`][31]
508+
3. [`attributeChangedCallback`][32]
509+
4. [`adoptedCallback`][33]
510+
5. [`updatedCallback`][34]
511+
6. [`mountedCallback`][35]
512+
7. [`formAssociatedCallback`][36]
513+
8. [`formDisabledCallback`][37]
514+
9. [`formResetCallback`][38]
510515
10. [`formStateRestoreCallback`][39]
511516

512517
## 脚手架
513518

514-
1. [基础][40]
515-
2. [仪表盘][41]
516-
3. [静态网站][42]
519+
1. [基础][22]
520+
2. [仪表盘][40]
521+
3. [移动端][41]
522+
4. [静态网站][42]
517523

518524
## 生态系统
519525

@@ -524,12 +530,12 @@ import 'web-cell/polyfill';
524530
- **UI 组件**
525531

526532
- [BootCell][44](基于 **BootStrap v5**
527-
- [Material Web][45](基于 **Material Design**
533+
- [MDUI][45](基于 **Material Design v3**
528534
- [GitHub Web Widget][46]
529535

530-
- **HTTP请求**[KoAJAX][47]基于 类**Koa** 中间件)
531-
- **实用程序**[Web utility][48]方法和类型
532-
- **事件流**[Iterable Observer][49]**Observable** 提案)
536+
- **HTTP 请求**[KoAJAX][47]基于类 **Koa** 中间件)
537+
- **实用程序**[Web utility][48] 方法和类型
538+
- **事件流**[Iterable Observer][49]`Observable` 提案)
533539
- **MarkDown 集成**[Parcel MDX transformer][50]**MDX** 编译器插件)
534540

535541
## 路线图
@@ -564,13 +570,14 @@ import 'web-cell/polyfill';
564570
[19]: https://mobx.js.org/enabling-decorators.html
565571
[20]: https://facebook.github.io/jsx/
566572
[21]: https://parceljs.org/
567-
[22]: https://web-cell.dev/scaffold/
573+
[22]: https://github.com/EasyWebApp/WebCell-scaffold
568574
[23]: https://developer.mozilla.org/zh-CN/docs/Web/API/Web_components
569575
[24]: https://web.dev/articles/custom-elements-v1?hl=zh-cn
570576
[25]: https://web.dev/articles/shadowdom-v1?hl=zh-cn
571577
[26]: https://web.dev/articles/more-capable-form-controls?hl=zh-cn
572578
[27]: https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties
573-
[28]: http://es6-features.org/
579+
[28]: https://developer.chrome.com/docs/web-platform/view-transitions?hl=zh-cn
580+
[29]: https://rse.github.io/es6-features/
574581
[30]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#connectedCallback
575582
[31]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#disconnectedCallback
576583
[32]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#attributeChangedCallback
@@ -581,12 +588,12 @@ import 'web-cell/polyfill';
581588
[37]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formDisabledCallback
582589
[38]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formResetCallback
583590
[39]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formStateRestoreCallback
584-
[40]: https://github.com/EasyWebApp/scaffold
585-
[41]: https://github.com/EasyWebApp/DashBoard
591+
[40]: https://github.com/EasyWebApp/WebCell-dashboard
592+
[41]: https://github.com/EasyWebApp/WebCell-mobile
586593
[42]: https://github.com/EasyWebApp/mark-wiki
587594
[43]: https://web-cell.dev/cell-router/
588595
[44]: https://bootstrap.web-cell.dev/
589-
[45]: https://material-web.dev/
596+
[45]: https://www.mdui.org/zh-cn/
590597
[46]: https://tech-query.me/GitHub-Web-Widget/
591598
[47]: https://web-cell.dev/KoAJAX/
592599
[48]: https://web-cell.dev/web-utility/

ReadMe.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ new DOMRenderer().render(
480480
### Tool chain
481481

482482
```shell
483-
npm install jsdom element-internals-polyfill
483+
npm install jsdom
484484
```
485485

486486
### Polyfill
@@ -489,6 +489,10 @@ npm install jsdom element-internals-polyfill
489489
import 'web-cell/polyfill';
490490
```
491491

492+
### Server Side Rendering
493+
494+
https://github.com/EasyWebApp/DOM-Renderer?tab=readme-ov-file#nodejs--bun
495+
492496
## Basic knowledge
493497

494498
- [Web components][23]
@@ -515,9 +519,10 @@ import 'web-cell/polyfill';
515519

516520
## Scaffolds
517521

518-
1. [Basic][40]
519-
2. [DashBoard][41]
520-
3. [Static site][42]
522+
1. [Basic][22]
523+
2. [DashBoard][40]
524+
3. [Mobile][41]
525+
4. [Static site][42]
521526

522527
## Ecosystem
523528

@@ -528,12 +533,12 @@ We recommend these libraries to use with WebCell:
528533
- **UI components**
529534

530535
- [BootCell][44] (based on **BootStrap v5**)
531-
- [Material Web][45] (based on **Material Design**)
536+
- [MDUI][45] (based on **Material Design v3**)
532537
- [GitHub Web Widget][46]
533538

534-
- **HTTP request**: [KoAJAX][47] (based on **Koa**\-like middlewares)
535-
- **Utility**: [Web utility][48] (Methods & Types)
536-
- **Event stream**: [Iterable Observer][49] (**Observable** proposal)
539+
- **HTTP request**: [KoAJAX][47] (based on **Koa**-like middlewares)
540+
- **Utility**: [Web utility][48] methods & types
541+
- **Event stream**: [Iterable Observer][49] (`Observable` proposal)
537542
- **MarkDown integration**: [Parcel MDX transformer][50] (**MDX** Compiler plugin)
538543

539544
## Roadmap
@@ -568,14 +573,14 @@ We recommend these libraries to use with WebCell:
568573
[19]: https://mobx.js.org/enabling-decorators.html
569574
[20]: https://facebook.github.io/jsx/
570575
[21]: https://parceljs.org/
571-
[22]: https://web-cell.dev/scaffold/
576+
[22]: https://github.com/EasyWebApp/WebCell-scaffold
572577
[23]: https://developer.mozilla.org/en-US/docs/Web/API/Web_components
573578
[24]: https://web.dev/articles/custom-elements-v1
574579
[25]: https://web.dev/articles/shadowdom-v1
575580
[26]: https://web.dev/articles/more-capable-form-controls
576581
[27]: https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties
577582
[28]: https://developer.chrome.com/docs/web-platform/view-transitions/
578-
[29]: http://es6-features.org/
583+
[29]: https://rse.github.io/es6-features/
579584
[30]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#connectedCallback
580585
[31]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#disconnectedCallback
581586
[32]: https://web-cell.dev/web-utility/interfaces/CustomElement.html#attributeChangedCallback
@@ -586,12 +591,12 @@ We recommend these libraries to use with WebCell:
586591
[37]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formDisabledCallback
587592
[38]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formResetCallback
588593
[39]: https://web-cell.dev/web-utility/interfaces/CustomFormElement.html#formStateRestoreCallback
589-
[40]: https://github.com/EasyWebApp/scaffold
590-
[41]: https://github.com/EasyWebApp/DashBoard
594+
[40]: https://github.com/EasyWebApp/WebCell-dashboard
595+
[41]: https://github.com/EasyWebApp/WebCell-mobile
591596
[42]: https://github.com/EasyWebApp/mark-wiki
592597
[43]: https://web-cell.dev/cell-router/
593598
[44]: https://bootstrap.web-cell.dev/
594-
[45]: https://material-web.dev/
599+
[45]: https://www.mdui.org/
595600
[46]: https://tech-query.me/GitHub-Web-Widget/
596601
[47]: https://web-cell.dev/KoAJAX/
597602
[48]: https://web-cell.dev/web-utility/

0 commit comments

Comments
 (0)