Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding contribution guide #413

Merged
merged 6 commits into from
Mar 15, 2024
Merged

docs: adding contribution guide #413

merged 6 commits into from
Mar 15, 2024

Conversation

Saeid-Za
Copy link
Contributor

@Saeid-Za Saeid-Za commented Mar 15, 2024

Please edit or add any other parts that you see fit.

resolves #409.

### CSS Classes
There are cases when we want to accept `class` as a prop in our `shadcn/vue` components and then combine it with a default style on our `radix-vue` component.

In these cases, we can not use `v-bind` while `class` is declared as a prop, because this would lead in [double class binding](https://github.com/radix-vue/shadcn-vue/pull/241), so the `class` propert must be dealt specefically.
Copy link
Collaborator

@sadeghbarati sadeghbarati Mar 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In these cases, we can not use v-bind while class is declared as a prop, because this would lead in double class binding, so the class propert must be dealt specefically.

We can use v-bind when class is declared as prop

we only use this way to prevent class duplication with cn function

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup. As long as we have class as prop, we can use v-bind 😁

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback ! I tried to be more clear on this one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also added some additional information based on CONTRIBUTING.md.

@sadeghbarati
Copy link
Collaborator

This is so nice Saeid 💯

Also I would add these changes to CONTRIBUTING.md too

@Saeid-Za
Copy link
Contributor Author

Some information in CONTRIBUTING.md was wrong, I also updated those.

@sadeghbarati sadeghbarati merged commit 38f5672 into unovue:dev Mar 15, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: Adding Detailed Contribution Guide
3 participants