|
| 1 | +# Contributing |
| 2 | + |
| 3 | +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +Please note we have a [code of conduct](https://github.com/design-sparx/mantine-analytics-dashboard/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. |
| 8 | + |
| 9 | +> This repo uses [changesets](https://github.com/changesets/changesets) to |
| 10 | +> make releasing updates easier. For you, the contributor, this means you |
| 11 | +> should run `npm run changeset` when you've got your changes ready. For |
| 12 | +> more details, see this short document on [adding a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository). |
| 13 | +
|
| 14 | +## Found an Issue? |
| 15 | + |
| 16 | +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](https://github.com/design-sparx/mantine-analytics-dashboard/issues/new/choose). Even better you can submit a Pull Request with a fix. |
| 17 | + |
| 18 | +## Submitting a Pull Request |
| 19 | + |
| 20 | +1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/design-sparx/mantine-analytics-dashboard/issues) or [open a new one](https://github.com/design-sparx/mantine-analytics-dashboard/issues/new/choose). |
| 21 | +2. Once done, [fork the repository](https://github.com/design-sparx/mantine-analytics-dashboard/fork) in your own GitHub account. |
| 22 | +3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository). |
| 23 | +4. Make the changes on your branch. |
| 24 | +5. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the main branch of the main repository. |
| 25 | + > We do not enforce a naming convention for the PRs, but please use something descriptive of your changes. |
| 26 | +
|
| 27 | +## Development Workflow |
| 28 | + |
| 29 | +Install dependencies |
| 30 | + |
| 31 | +``` |
| 32 | +pnpm install |
| 33 | +``` |
| 34 | + |
| 35 | +Run dev server |
| 36 | + |
| 37 | +``` |
| 38 | +pnpm run dev |
| 39 | +``` |
| 40 | + |
| 41 | +## Linter |
| 42 | + |
| 43 | +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`. |
| 44 | + |
| 45 | +## Commit Message |
| 46 | + |
| 47 | +We use [commitlint](https://commitlint.js.org/guides/getting-started) to manage and standardize our commits: |
| 48 | + |
| 49 | +- check [commitlint conventional guides](https://github.com/conventional-changelog/commitlint?tab=readme-ov-file#what-is-commitlint), |
| 50 | +- not finish by a dot or any other punctuation character (!,?), |
| 51 | +- 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" |
0 commit comments