CONTRIBUTING.md

Contribution Guidelines

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 de# 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 the library

• From the root of the project run pnpm install.

• Then run nx build cypress-ct-qwik.

• Visit the URL printed in the console and you'll have a page opened with the suite of widgets.

▶ 5. Make sure you add / modify tests

Run pnpm run test to make sure there aren't any errors

▶ 6. Commit your changes using commitizen:

Instead of git commit use the following command:

pnpm run commit

It will then ask you a bunch of questions.

This will create a descriptive commit message that follows the Angular commit message convention.

This is necessary to generate meaningful release notes / CHANGELOG automatically.

▶ 7. Push your branch to GitHub:

git push origin my-fix-branch

▶ 8. Create a PR

In GitHub, create a pull request for qwikifiers/cypress-qwik: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

▶ 9. 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

▶ 10. That's it! Thank you for your contribution! 🙏💓