Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.19 KB

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.

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

npm install

Run dev server

npm run start:dev

Linter

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

Commit Message

As minimal requirements, your commit message should:

  • be capitalized
  • 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 bug" or "Add support for x feature"