Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.88 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests.

Please note we have a code of conduct, please follow it in all your interactions with the project.

This repo uses changesets to make releasing updates easier. For you, the contributor, this means you should run npm run changeset when you've got your changes ready. For more details, see this short document on adding a changeset.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.

Submitting a Pull Request

  1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an existing issue or open a new one.
  2. Once done, fork the repository in your own GitHub account.
  3. Create a new Git branch.
  4. Make the changes on your branch.
  5. Submit the branch as a PR pointing to the main branch of the main repository.

    We do not enforce a naming convention for the PRs, but please use something descriptive of your changes.

Development Workflow

Install dependencies

pnpm install

Run dev server

pnpm run dev

Linter

Each PR should pass the linter to be accepted. To fix lint and prettier errors, run pnpm run lint:fix and pnpm run prettier:fix.

Commit Message

We use commitlint to manage and standardize our commits:

  • check commitlint conventional guides,
  • not finish by a dot or any other punctuation character (!,?),
  • start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message. e.g.: "Fix the home page button" or "Add support for dark mode"