Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (37 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 3.54 KB
Raw

Contributing to shadcn-svelte

We appreciate your interest in contributing. This guide will help you get started with the contribution process.

Table of Contents

Ways to contribute

We welcome all kinds of contributions:

  • Feedback - have suggestions or ideas? Open a discussion to discuss it. Just note that this project is a port of shadcn/ui, meaning if a feature is not in shadcn/ui, it will not be considered here.
  • Help & Support - if you enjoy helping others, join the Discord and help out in the libs -> shadcn-support channel, or answer questions asked in Discussions
  • Bug reports - please open an issue to report a bug.
  • Docs fixes - spot a typo or broken link? Open a PR. If it's a larger change, please start a discussion first.
  • Code improvements - For anything more involved than a quick fix, start a discussion first so we can align before you dive in.

How to contribute

We try to keep the process simple to avoid wasted effort:

1. Reporting bugs

Open an issue here. Make sure to provide a minimal reproduction of the issue to save our contributors time triaging your issue.

If your bug is a typo or small tweak, feel free to skip the discussion and just open a PR.

2. Requesting missing features from shadcn/ui

Before requesting a feature please check if it is already in shadcn/ui. If it is, please open an issue here to request it. Feel free to attach the PR, announcement or any other material that might be helpful to the maintainers.

Maintainers will tag these issues with the parity label.

3. Opening PRs

Thanks for contributing to shadcn-svelte!

We ask that you follow these guidelines to help make it easier for us to review your PR:

  • Your PR should fix a single issue linked in the PR description (e.g. Fixes #123)
  • Your PR should pass all CI checks and show a checkmark (Maintainers won't review PRs on red, or in draft)

Responsible use of AI

We take no issue with you using AI to help you contribute to shadcn-svelte. However we ask that when creating an issue, and writing PR descriptions you refrain from using AI to generate the content. AI is very good at writing code but often far too verbose when writing documentation, writing your own description will help us parse your contributions more easily.

If you are using AI to help you contribute from another language than English we ask that you translate your own description of the issue or PR.

Questions

If you're looking to contribute and have questions about the process or the codebase in general, feel free to ask in the Discord in the Questions->shadcn-svelte channel!

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project.