Contributing

Questions

If you have questions about implementation details, help, or support, please use the community forum at Github Discussions.

If you have found what you think is a bug, please file an issue.

If you want to suggest a feature, create an issue if it does not already exist. From there, we will discuss use-cases and implementation details.

While contributing, make sure to follow the guidelines:

run npm run verify before opening a PR
write tests for any new piece of code that you are adding to the repository when applicable

vue-query is using commitlint to enable semantic-release bot.

Maintainers should merge pull requests by squashing all commits and editing the commit message if necessary, using the GitHub user interface.

Use an appropriate commit type. Be especially careful with breaking changes.

For each new commit added to the main branch (push or merge), a GitHub action gets triggered that runs the semantic-release