Skip to content

Commit 07f71df

Browse files
peterroepeterroe
committed
feat: document
1 parent 90e176d commit 07f71df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+7028
-109
lines changed

‎docs/.github/ISSUE_TEMPLATE/bug_report.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: 🐞 Bug report
2+
description: Report an issue
3+
labels: [pending triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
14+
placeholder: Bug description
15+
validations:
16+
required: true
17+
- type: input
18+
id: reproduction
19+
attributes:
20+
label: Reproduction
21+
description: A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is **required**, otherwise the issue might be closed without further notice. [**Why & How?**](https://antfu.me/posts/why-reproductions-are-required)
22+
placeholder: Reproduction
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: system-info
27+
attributes:
28+
label: System Info
29+
description: Output of `npx envinfo --system --binaries --browsers`
30+
render: Shell
31+
placeholder: System, Binaries, Browsers
32+
validations:
33+
required: true
34+
- type: dropdown
35+
id: package-manager
36+
attributes:
37+
label: Used Package Manager
38+
description: Select the used package manager
39+
options:
40+
- npm
41+
- yarn
42+
- pnpm
43+
- bun
44+
- n/a
45+
validations:
46+
required: true
47+
- type: checkboxes
48+
id: checkboxes
49+
attributes:
50+
label: Validations
51+
description: Before submitting the issue, please make sure you do the following
52+
options:
53+
- label: Follow our [Code of Conduct](https://github.com/antfu/.github/blob/main/CODE_OF_CONDUCT.md)
54+
required: true
55+
- label: Read the [Contributing Guide](https://github.com/antfu/contribute).
56+
required: true
57+
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
58+
required: true
59+
- label: Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
60+
required: true
61+
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
62+
required: true

‎docs/.github/ISSUE_TEMPLATE/config.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: 🙌 Contribution Guide
3+
url: https://github.com/antfu/contribute
4+
about: Please read through before making contributions.
5+
- name: 💬 Anthony's Discord Server
6+
url: https://chat.antfu.me/
7+
about: Want to discuss / chat with the community? Here you go!
8+
- name: ⁉️ Why and How to make a reproduction?
9+
url: https://antfu.me/posts/why-reproductions-are-required
10+
about: Reproduction is very important for maintainer to help on your issues!

‎docs/.github/ISSUE_TEMPLATE/feature_request.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🚀 New feature proposal
2+
description: Propose a new feature
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for your interest in the project and taking the time to fill out this feature report!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Clear and concise description of the problem
13+
description: 'As a developer using VueUse I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: suggested-solution
18+
attributes:
19+
label: Suggested solution
20+
description: 'In module [xy] we could provide following implementation...'
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternative
25+
attributes:
26+
label: Alternative
27+
description: Clear and concise description of any alternative solutions or features you've considered.
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: Any other context or screenshots about the feature request here.
33+
- type: checkboxes
34+
id: checkboxes
35+
attributes:
36+
label: Validations
37+
description: Before submitting the issue, please make sure you do the following
38+
options:
39+
- label: Follow our [Code of Conduct](https://github.com/antfu/.github/blob/main/CODE_OF_CONDUCT.md)
40+
required: true
41+
- label: Read the [Contributing Guide](https://github.com/antfu/contribute).
42+
required: true
43+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
44+
required: true

‎docs/.github/ISSUE_TEMPLATE/typo.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: 👀 Typo / Grammar fix
2+
description: You can just go ahead and send a PR! Thank you!
3+
labels: []
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## PR Welcome!
9+
10+
If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
11+
If you spot multiple of them, we suggest combining them into a single PR. Thanks!
12+
- type: textarea
13+
id: context
14+
attributes:
15+
label: Additional context

‎docs/.github/PULL_REQUEST_TEMPLATE.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- DO NOT INGORE THE TEMPLATE!
2+
3+
Thank you for contributing!
4+
5+
Before submitting the PR, please make sure you do the following:
6+
7+
- Read the [Contributing Guide](https://github.com/antfu/contribute).
8+
- Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
9+
- Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
10+
- Ideally, include relevant tests that fail without this PR but pass with it.
11+
12+
-->
13+
14+
### Description
15+
16+
<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
17+
18+
### Linked Issues
19+
20+
21+
### Additional context
22+
23+
<!-- e.g. is there anything you'd like reviewers to focus on? -->

‎docs/.github/workflows/ci.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
pull_request:
9+
branches:
10+
- master
11+
12+
jobs:
13+
lint:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
18+
- name: Install pnpm
19+
uses: pnpm/action-setup@v2
20+
21+
- name: Set node
22+
uses: actions/setup-node@v3
23+
with:
24+
node-version: 16.x
25+
cache: pnpm
26+
27+
- name: Setup
28+
run: npm i -g @antfu/ni
29+
30+
- name: Install
31+
run: nci
32+
33+
- name: Lint
34+
run: nr lint
35+
36+
typecheck:
37+
runs-on: ubuntu-latest
38+
steps:
39+
- uses: actions/checkout@v3
40+
41+
- name: Install pnpm
42+
uses: pnpm/action-setup@v2
43+
44+
- name: Set node
45+
uses: actions/setup-node@v3
46+
with:
47+
node-version: 16.x
48+
cache: pnpm
49+
50+
- name: Setup
51+
run: npm i -g @antfu/ni
52+
53+
- name: Install
54+
run: nci
55+
56+
- name: Typecheck
57+
run: nr typecheck
58+
59+
test:
60+
runs-on: ${{ matrix.os }}
61+
62+
strategy:
63+
matrix:
64+
node: [16.x, 18.x]
65+
os: [ubuntu-latest, windows-latest, macos-latest]
66+
fail-fast: false
67+
68+
steps:
69+
- uses: actions/checkout@v3
70+
71+
- name: Install pnpm
72+
uses: pnpm/action-setup@v2
73+
74+
- name: Set node version to ${{ matrix.node }}
75+
uses: actions/setup-node@v3
76+
with:
77+
node-version: ${{ matrix.node }}
78+
cache: pnpm
79+
80+
- name: Setup
81+
run: npm i -g @antfu/ni
82+
83+
- name: Install
84+
run: nci
85+
86+
- name: Build
87+
run: nr build
88+
89+
- name: Test
90+
run: nr test

‎docs/.github/workflows/release.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# .github/workflows/release.yml
2+
3+
name: Release
4+
5+
on:
6+
push:
7+
tags:
8+
- 'v*'
9+
10+
jobs:
11+
release:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
18+
- uses: actions/setup-node@v3
19+
with:
20+
node-version: 16.x
21+
22+
- run: npx changelogithub # or [email protected] if ensure the stable result
23+
env:
24+
GITHUB_TOKEN: ${{secrets.ACTION_TOKEN}}

‎docs/.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.vitepress/cache/
2+
.vitepress/dist/
3+
node_modules
4+
.DS_Store
5+
*.log
6+
dist

0 commit comments

Comments
 (0)