Skip to content

Commit 2e3635f

Browse files
authored
chore: fix pr template + add bun.lockb + some linting
* chore: add bun for installation * Update PULL_REQUEST_TEMPLATE.md * Update build.yml * chore: linting
1 parent 4c7692a commit 2e3635f

File tree

13 files changed

+237
-229
lines changed

13 files changed

+237
-229
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- [ ] New Page
66
- [ ] Minor Fix
7+
- [ ] Minor Improvement
78
- [ ] Major Improvement
89

910
#### Description (required)

.github/workflows/build.yml

+16-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ jobs:
1515
steps:
1616
- uses: actions/checkout@v3
1717

18+
- name: Get yarn cache directory path
19+
id: yarn-cache-dir-path
20+
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
21+
22+
- uses: actions/cache@v4
23+
id: yarn-cache
24+
with:
25+
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
26+
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
27+
restore-keys: |
28+
${{ runner.os }}-yarn-
29+
1830
- name: Node.js 18
1931
uses: actions/setup-node@v3
2032
with:
@@ -23,6 +35,8 @@ jobs:
2335
- name: Install Dependencies
2436
run: yarn install --frozen-lockfile
2537

26-
- name: Build
38+
- name: Run Build
2739
run: yarn build
28-
40+
41+
# - name: Run Lint
42+
# run: yarn lint

CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ We're excited you're interested in contributing to our Turborepo-based Docusauru
77
- [Node.js](https://nodejs.org/en/) (version 18 or above)
88
- [Yarn](https://yarnpkg.com/) package manager
99

10+
For installing dependencies faster using [Bun](http://bun.sh/): `bun install`
11+
1012
## Project Structure
1113

1214
This project uses Turborepo to manage a monorepo structure. The documentation site is likely one of the workspaces within this structure.

0 commit comments

Comments
 (0)