Niklas/shadcn-vue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: adding syncing section

Browse Source
This commit is contained in:
Saeid Zareie 2024-06-30 19:58:38 +03:30
parent cdfbd51190
commit dc30a4bc1a
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/www/src/content/docs/changelog.md
View File

@ -134,6 +134,6 @@ The Sonner component is provided by [vue-sonner](https://vue-sonner.vercel.app/)
### New Component - Carousel
[`Carousel`](/docs/components/toggle-group.html) - A carousel with motion and swipe built using [Embla](https://www.embla-carousel.com/) library.
[`Carousel`](/docs/components/carousel.html) - A carousel with motion and swipe built using [Embla](https://www.embla-carousel.com/) library.
<ComponentPreview name="CarouselDemo" />

25
apps/www/src/content/docs/contribution.md
View File

@ -2,6 +2,13 @@
title: Contribution
description: Learn on how to contribute to shadcn/vue.
---
<script setup lang="ts">
import { Button } from "@/lib/registry/new-york/ui/button"
const latestSyncCommitTag = "06cc0cdf3d080555d26abbe6639f2d7f6341ec73"
const diffUrl = `https://github.com/shadcn-ui/ui/compare/${latestSyncCommitTag}...main`
</script>
## Introduction
Thanks for your interest in contributing to shadcn-vue.com. We're happy to have you here.
@ -326,6 +333,24 @@ const props = withDefaults(defineProps<Props>(), {
You'll need to extend `PrimitiveProps` in your props to support `Primitive` component. In most cases you would also need a default value for [`as`](https://www.radix-vue.com/utilities/primitive.html#changing-as-value) property.
## Updating with `shadcn/ui`
`shadcn/vue` is an unofficial, community-led Vue port of `shadcn/ui`, as time goes by, they might get out of sync.
as of today, we are in sync with this [commit](https://github.com/shadcn-ui/ui/commit/06cc0cdf3d080555d26abbe6639f2d7f6341ec73) of `shadcn/ui`.
There is a recommended process to keep track of the updates and applying them here in `shadcn/vue`, click on the following link to check if there are newer commits that we should be synced with.
<div class="text-center">
<a :href="diffUrl" target="_blank">
<Button>
Check Diff
</Button>
</a>
</div>
1. There are no changes - If you see "There isn’t anything to compare", nothing needs to be done as we are synced with latest version.
2. If there are changes, you should review thoese changes and try to apply them on `shadcn/vue` codebase and create a PR, remember to update the `latestSyncCommitTag` in [this file](https://github.com/radix-vue/shadcn-vue/blob/dev/apps/www/src/content/docs/contribution.md) too.
## Debugging
Here are some tools and techniques that can help you debug more effectively while contributing to `shadcn/vue` or developing your own projects.