You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-98Lines changed: 26 additions & 98 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,29 +11,40 @@ pnpm install
11
11
# Build all packages
12
12
pnpm build
13
13
14
-
# Run tests
14
+
# Run tests (both browser and unit tests)
15
15
pnpm test
16
16
17
-
# Run dev mode (watches for changes)
17
+
# Run dev mode (watches for changes and rebuilds all packages)
18
18
pnpm dev
19
19
20
+
# Run the demo application
21
+
pnpm demo
22
+
20
23
# Lint and format code
21
-
pnpm run lint
22
-
pnpm run lint:fix
23
-
pnpm run format
24
+
pnpm oxlint
25
+
pnpm oxlint --fix
26
+
pnpm oxfmt
24
27
```
25
28
29
+
I usually run `pnpm demo` in parallel to `pnpm dev`.
30
+
26
31
## Making Changes
27
32
28
33
1. Create a branch from `main`
29
34
2. Make your changes in the relevant package under `packages/`
30
35
3. Add tests if applicable
31
-
4. Ensure code passes linting: `pnpm run lint`
36
+
4. Ensure code passes linting: `pnpm oxlint`
32
37
5. Run tests: `pnpm test`
38
+
6.[optional] add changeset
39
+
7. open a PR
40
+
41
+
> Please provide a description of the intended change in the PR.
42
+
43
+
> Commit messages should follow [convential commit standard](https://www.conventionalcommits.org/en/v1.0.0/)
33
44
34
-
## Versioning with Changesets
45
+
## Versioning
35
46
36
-
This monorepo uses [changesets](https://github.com/changesets/changesets) for managing independent package versions and changelogs.
47
+
This monorepo uses [semantic versioning](https://semver.org). Package versions are managed with [changesets](https://github.com/changesets/changesets) for independent package versions and changelogs.
37
48
38
49
### Creating a Changeset
39
50
@@ -43,111 +54,28 @@ After making changes, create a changeset:
43
54
pnpm changeset
44
55
```
45
56
46
-
This will prompt you to:
47
-
48
-
1.**Select affected packages** - Choose which packages were modified
49
-
2.**Select version bump** - Choose between:
50
-
-`patch` - Bug fixes (0.0.X)
51
-
-`minor` - Features (0.X.0)
52
-
-`major` - Breaking changes (X.0.0)
53
-
3.**Write summary** - Describe your changes for the changelog
54
-
55
-
Example:
56
-
57
-
```
58
-
✔ Which packages would you like to include? … @vingy/vuebugger
59
-
✔ Which packages should have a MAJOR bump? … no
60
-
✔ Which packages should have a MINOR bump? … @vingy/vuebugger
61
-
✔ Write a summary for this change: Added support for custom options
62
-
63
-
Summary: Added support for custom options
64
-
```
65
-
66
57
This creates a file in `.changeset/` (e.g., `.changeset/brave-lions-enjoy.md`). Commit this file with your changes.
67
58
68
-
### Before Publishing
69
-
70
-
The maintainers will handle versioning and publishing:
0 commit comments