docs(*): update CONTRIBUTING.md #7165
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit b1f8669. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit b1f8669:
|
CONTRIBUTING.md
Outdated
| - **chore**: Changes to the build process or auxiliary tools and libraries such as documentation | ||
| generation | ||
| - **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation | ||
| - **types**: A code change related with TypeScript type |
There was a problem hiding this comment.
I think I just did that wrong:
https://www.conventionalcommits.org/en/v1.0.0/
types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
| @@ -63,7 +111,7 @@ We have very precise rules over how our git commit messages can be formatted. Th | |||
| Each commit message consists of a **header**, a **body** and a **footer**. The header has a special | |||
| format that includes a **type**, a **scope** and a **subject**: | |||
|
|
|||
| ``` | |||
| ```text | |||
There was a problem hiding this comment.
nit. Markdownlint (I used this plugin) check this
https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md040.md
|
|
||
| ### Scope | ||
|
|
||
| The scope could be anything specifying place of the commit change. For example `useQuery`, `useMutation` etc... | ||
| The scope could be anything specifying place of the commit change. For example `query-core`, `react-query` etc... |
There was a problem hiding this comment.
TanStack Query has become a framework-independent library, and this monorepo is developing adapters for TanStack Query for various frameworks.
So I thought it would be better for this scope to use the library name (react-query) rather than a name that could be duplicated, such as useQuery.
https://github.com/TanStack/query/commits/main/
| ```bash | ||
| pnpm install | ||
| ``` |
There was a problem hiding this comment.
When using bash, I thought it would be good to make it easy to copy bash commands.
No description provided.