Contribution Guidelines

September 7, 2025 · View on GitHub

We would love for you to contribute to this project. As a contributor, here are the guidelines we would like you to follow:

Be Kind - Code of Conduct

Please read and follow our Code of Conduct to help us keep this project open and inclusive.

Found a bug? Want a feature? - Submit an Issue

Choose an issue template to file a bug report / feature request.

Ready to contribute a Pull Request (PR)?

▶ 1. First - Search this repo for existing PRs !

Try to find an open or closed PR that relates to the change you want to introduce.

▶ 2. Before you start coding - find / create an issue

Make sure there's an issue describing the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.

Don't waste your time working on code before you got a 👍 in an issue comment.

▶ 3. Fork the this repo and create a branch.

Hit that "Fork" button above (in this repo's github page).

git clone your fork

git clone YOUR_FORK_URL

Get your url by from here 👇

Create a new branch locally in your fork's repo

git checkout -b my-fix-branch main

▶ 4. Build, lint and test the library

From the root of the project run pnpm install.
Then run pnpm build.
Run pnpm lint to lint the code.
Run pnpm test to run the tests.

▶ 5. Add a "changeset"

For your convenience, I've added a video tutorial I prepared for Qwik that covers the process of adding a changeset:

📽 TUTORIAL: Adding a changeset

5.1. Run the following command to create a changeset:

pnpm change

5.2. Choose the packages that should be included in the changeset

5.3 Choose the specific type of change

(hit Enter if you need to skip to the next option)

major for breaking changes
minor for new features
patch for bug fixes

5.4. Prefix your change title with one of these:

FEAT: or feat: for features
FIX: or fix: for bug fixes
DOCS or docs: for documentation
CHORE: or chore: for chores
INFRA: or infra: for infrastructure changes

5.5. Modify the created MD file

After the change command runs, a new MD file will be created under the .changeset folder.

Please modify this file to include a descriptive message of the changes you made.

You can even add code examples if you need do, to describe a new feature for example. (pun intended 😉)

The prefix and this elaborated description will be used to create the changelog files and release notes, so please give them love. 💗😊

▶ 6. Push your branch to GitHub:

git push origin my-fix-branch

▶ 7. Create a PR

In GitHub, create a pull request for hirezio/vitest-browser-angular:main.

Make sure you check the following checkbox "Allow edits from maintainers" -

If you need to update your PR for some reason -

Make the required updates.
Re-run the tests to ensure tests are still passing pnpm run test
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
```
git rebase main -i
git push -f
```

▶ 8. After your PR is merged - delete your branches

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
Check out the main branch:
```
git checkout main -f
```
Delete the local branch:
```
git branch -D my-fix-branch
```
Update your main with the latest upstream version:
```
git pull --ff upstream main
```