Skip to content

Commit

Permalink
Revert "added docs for changesets"
Browse files Browse the repository at this point in the history
This reverts commit 62dd297.
maiieul committed Aug 26, 2024
1 parent e2a93f5 commit ceef907
Showing 3 changed files with 333 additions and 11 deletions.
16 changes: 5 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -38,7 +38,7 @@ Before submitting a pull request, consider the following guidelines:
- In your forked repository, create a new branch: `git checkout -b my-branch main`
- Make your changes/fixes.
- Run `pnpm fmt` to lint the code.
- Add a changeset with `pnpm change` if needed ([follow this tutorial](https://go.screenpal.com/watch/cZivIcVPJQV))
- Commit your code with a good commit message [using "Commitizen"](#committing-using-commitizen).
- Push your branch to GitHub: `git push origin my-branch`
- In GitHub, send a pull request to `QwikDev:main`.

@@ -325,21 +325,15 @@ This will show an interactive UI to update all dependencies. Be careful about pe
- Review PR in StackBlitz
![image](https://user-images.githubusercontent.com/4918140/195581745-8dfca1f9-2dcd-4f6a-b7aa-705f3627f8fa.png)

### Adding a changeset:
### Committing using "Commitizen":

Whenever you make a change that requires documentation or a new release, you should add a changeset. This will help us to keep track of changes and generate meaningful release notes and changelog files.

You create a new changeset file by running:
Instead of using `git commit` please use the following command:

```shell
pnpm change
pnpm commit
```

For your convenience, we prepared a video tutorial that covers the process of adding a changeset:

[📽 TUTORIAL: Adding a changeset](https://go.screenpal.com/watch/cZivIcVPJQV)


You'll be asked guiding questions which will eventually create a descriptive commit message and necessary to generate meaningful release notes / CHANGELOG automatically.

### Pre-submit hooks

6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -7,6 +7,9 @@
"03": "devDependencies can't include reference to @builder.io/qwik-city or e2e test will fail."
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
},
"syncpack": {
"versionGroups": [
{
@@ -95,10 +98,12 @@
"@typescript-eslint/utils": "^7.7.1",
"all-contributors-cli": "6.26.1",
"brotli": "1.3.3",
"commitizen": "4.3.0",
"concurrently": "^8.2.2",
"create-qwik": "workspace:^",
"cross-spawn": "7.0.3",
"csstype": "^3.1.3",
"cz-conventional-changelog": "3.3.0",
"dotenv": "^16.4.5",
"esbuild": "^0.20.2",
"eslint": "^8.57.0",
@@ -179,6 +184,7 @@
"cli": "pnpm build.cli && node packages/create-qwik/dist/create-qwik.cjs && tsm scripts/validate-cli.ts --copy-local-qwik-dist",
"cli.qwik": "pnpm build.cli && node packages/qwik/dist/qwik-cli.cjs",
"cli.validate": "tsm scripts/validate-cli.ts",
"commit": "git-cz",
"deps": "corepack pnpm upgrade -i -r --latest && syncpack fix-mismatches && corepack pnpm dedupe",
"docs.dev": "cd packages/docs && pnpm build.repl-sw && pnpm dev",
"docs.preview": "cd packages/docs && pnpm preview",
Loading

0 comments on commit ceef907

Please sign in to comment.