From c21ecfb665214e18cd5914ea319f925cd676e786 Mon Sep 17 00:00:00 2001 From: Nikhar Pandya <70164257+NikharPandya@users.noreply.github.com> Date: Thu, 31 Aug 2023 09:01:36 -0400 Subject: [PATCH] docs(www): update contrubuting.md and next.mdx (#1343) * docs: Update CONTRIBUTING.md added commit convention section to the contribution docs. * docs: Update next.mdx for dark mode --------- Co-authored-by: shadcn --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++ apps/www/content/docs/dark-mode/next.mdx | 8 ++++++ 2 files changed, 42 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bf1e22b6..f6965d189 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,6 +107,40 @@ When adding or modifying components, please ensure that: 2. You update the documentation. 3. You run `pnpm build:registry` to update the registry. +## Commit Convention + +Before you create a Pull Request, please check whether your commits comply with +the commit conventions used in this repository. + +When you create a commit we kindly ask you to follow the convention +`category(scope or module): message` in your commit message while using one of +the following categories: + +- `feat / feature`: all changes that introduce completely new code or new + features +- `fix`: changes that fix a bug (ideally you will additionally reference an + issue if present) +- `refactor`: any code related change that is not a fix nor a feature +- `docs`: changing existing or creating new documentation (i.e. README, docs for + usage of a lib or cli usage) +- `build`: all changes regarding the build of the software, changes to + dependencies or the addition of new dependencies +- `test`: all changes regarding tests (adding new tests or changing existing + ones) +- `ci`: all changes regarding the configuration of continuous integration (i.e. + github actions, ci system) +- `chore`: all changes to the repository that do not fit into any of the above + categories + + e.g. `feat(components): add new prop to the avatar component` + + +If you are interested in the detailed specification you can visit +https://www.conventionalcommits.org/ or check out the +[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). + + + ## Requests for new components If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out. diff --git a/apps/www/content/docs/dark-mode/next.mdx b/apps/www/content/docs/dark-mode/next.mdx index ef7489cad..84bccb974 100644 --- a/apps/www/content/docs/dark-mode/next.mdx +++ b/apps/www/content/docs/dark-mode/next.mdx @@ -7,6 +7,14 @@ description: Adding dark mode to your next app. +### Install next-themes + +Start by installing `next-themes`: + +```bash +npm install next-themes +``` + ### Create a theme provider ```tsx title="components/theme-provider.tsx"