Skip to content

Commit

Permalink
[add] PR badges configuration
Browse files Browse the repository at this point in the history
[optimize] simplify Repository model based on MobX-GitHub
[optimize] update Upstream packages
  • Loading branch information
TechQuery committed Jun 6, 2024
1 parent 8e796c6 commit a4b966d
Show file tree
Hide file tree
Showing 11 changed files with 177 additions and 167 deletions.
17 changes: 17 additions & 0 deletions .github/pr-badge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
- icon: visualstudio
label: 'GitHub.dev'
message: 'PR-$prNumber'
color: 'blue'
url: 'https://github.dev/$owner/$repo/pull/$prNumber'

- icon: github
label: 'GitHub codespaces'
message: 'PR-$prNumber'
color: 'black'
url: 'https://codespaces.new/$owner/$repo/pull/$prNumber'

- icon: git
label: 'GitPod.io'
message: 'PR-$prNumber'
color: 'orange'
url: 'https://gitpod.io/?autostart=true#https://github.com/$owner/$repo/pull/$prNumber'
70 changes: 39 additions & 31 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

## Technology stack

- Language: [TypeScript v5][9]
- Component engine: [PReact v10][10]
- State management: [MobX v6][11]
- Component suite: [React Bootstrap v2][12]
- HTTP Client: [KoAJAX v1][13]
- PWA framework: [Workbox v7][14]
- Package bundler: [Parcel v2][15]
- CI / CD: GitHub [Actions][16] + [Pages][17]
- Language: [TypeScript v5][2]
- Component engine: [PReact v10][9]
- State management: [MobX v6][3]
- Component suite: [React Bootstrap v2][10]
- HTTP Client: [KoAJAX v1][11]
- PWA framework: [Workbox v7][12]
- Package bundler: [Parcel v2][13]
- CI / CD: GitHub [Actions][14] + [Pages][15]

## Extra components

Expand All @@ -31,13 +31,22 @@

## Best practice

1. Install **[Settings][19] GitHub app** in your account or organization
2. Click the **[Use this template][20] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
1. Install GitHub apps in your organization or account:

1. [Probot settings][16]: set up Issue labels & Pull Request rules
2. [PR badge][17]: set up Online [VS Code][18] editor entries in Pull Request description

2. Click the **[Use this template][19] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above

3. Click the **[Open in GitHub codespaces][7] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately
4. Set [Vercel variables][21] as [Repository secrets][22], then every commit will get an independent **Preview URL**
5. Recommend to add a [Notification step in GitHub actions][23] for your Team IM app
6. Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][24] instead of IM messages or Mobile Phone calls
7. Collect all these issues into [Project kanbans][25], then create **Pull requests** & add `closes #issue_number` into its description for automation

4. Set [Vercel variables][20] as [Repository secrets][21], then every commit will get an independent **Preview URL**

5. Recommend to add a [Notification step in GitHub actions][22] for your Team IM app

6. Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][23] instead of IM messages or Mobile Phone calls

7. Collect all these issues into [Project kanbans][24], then create **Pull requests** & add `closes #issue_number` into its description for automation

## Development

Expand All @@ -63,20 +72,19 @@ pnpm build
[6]: https://github.com/idea2app/React-MobX-Bootstrap-ts/actions/workflows/main.yml
[7]: https://codespaces.new/idea2app/React-MobX-Bootstrap-ts
[8]: https://gitpod.io/?autostart=true#https://github.com/idea2app/React-MobX-Bootstrap-ts
[9]: https://www.typescriptlang.org/
[10]: https://preactjs.com/
[11]: https://mobx.js.org/
[12]: https://react-bootstrap.github.io/
[13]: https://github.com/EasyWebApp/KoAJAX
[14]: https://developers.google.com/web/tools/workbox
[15]: https://parceljs.org/
[16]: https://github.com/features/actions
[17]: https://pages.github.com/
[18]: https://github.com/idea2app/React-Bootstrap-editor
[19]: https://github.com/apps/settings
[20]: https://github.com/new?template_name=React-MobX-Bootstrap-ts&template_owner=idea2app
[21]: https://github.com/idea2app/Next-Bootstrap-ts/blob/80967ed49045af9dbcf4d3695a2c39d53a6f71f1/.github/workflows/pull-request.yml#L9-L11
[22]: https://github.com/idea2app/React-MobX-Bootstrap-ts/settings/secrets/actions
[23]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
[24]: https://github.com/idea2app/React-MobX-Bootstrap-ts/issues/new/choose
[25]: https://github.com/idea2app/React-MobX-Bootstrap-ts/projects
[9]: https://preactjs.com/
[10]: https://react-bootstrap.github.io/
[11]: https://github.com/EasyWebApp/KoAJAX
[12]: https://developers.google.com/web/tools/workbox
[13]: https://parceljs.org/
[14]: https://github.com/features/actions
[15]: https://pages.github.com/
[16]: https://github.com/apps/settings
[17]: https://pullrequestbadge.com/
[18]: https://code.visualstudio.com/
[19]: https://github.com/new?template_name=React-MobX-Bootstrap-ts&template_owner=idea2app
[20]: https://github.com/idea2app/React-MobX-Bootstrap-ts/blob/8e796c6e7dc485fe4a68b59fcbffb9d224236bf4/.github/workflows/main.yml#L10-L12
[21]: https://github.com/idea2app/React-MobX-Bootstrap-ts/settings/secrets/actions
[22]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
[23]: https://github.com/idea2app/React-MobX-Bootstrap-ts/issues/new/choose
[24]: https://github.com/idea2app/React-MobX-Bootstrap-ts/projects
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@
"echarts-jsx": "^1.2.0",
"editorjs-html": "^3.4.3",
"idea-react": "^2.0.0-rc.2",
"koajax": "^1.1.0",
"koajax": "^1.1.2",
"lodash": "^4.17.21",
"mobx": "^6.12.3",
"mobx-github": "^0.3.1",
"mobx-i18n": "^0.5.0",
"mobx-react": "^9.1.1",
"mobx-restful": "^1.0.0-rc.5",
"mobx-restful": "^1.0.0-rc.6",
"mobx-restful-table": "^2.0.0-rc.1",
"preact": "^10.22.0",
"react-bootstrap": "^2.10.2",
Expand All @@ -33,21 +34,20 @@
"web-utility": "^4.4.0"
},
"devDependencies": {
"@babel/runtime": "^7.24.6",
"@octokit/openapi-types": "^22.2.0",
"@babel/runtime": "^7.24.7",
"@parcel/config-default": "~2.12.0",
"@parcel/packager-raw-url": "~2.12.0",
"@parcel/transformer-less": "~2.12.0",
"@parcel/transformer-typescript-tsc": "~2.12.0",
"@parcel/transformer-webmanifest": "~2.12.0",
"@types/lodash": "^4.17.4",
"@types/node": "^18.19.33",
"@types/node": "^18.19.34",
"buffer": "^6.0.3",
"husky": "^9.0.11",
"lint-staged": "^15.2.5",
"parcel": "~2.12.0",
"parcel-transformer-mdx": "^0.3.2",
"prettier": "^3.2.5",
"prettier": "^3.3.1",
"prismjs": "^1.29.0",
"process": "^0.11.10",
"typescript": "~5.4.5",
Expand Down
Loading

0 comments on commit a4b966d

Please sign in to comment.