Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 2.8 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

Questions

If you have questions about the project, please start a new discussion in the Discussions, or join the Discord and ask your question under the shadcn-svelte -> shadcn-support channel.

Contributing

This project is open to contributions from the community.

We welcome contributions in the following areas:

  • Feedback: We're always looking for feedback on the project. If you have any suggestions or ideas, please open an issue to discuss it.
  • Support: If you feel confident in your ability to help others with their questions, please join the Discord and help out in the shadcn-svelte -> shadcn-support channel.
  • Feature enhancements: If you have an idea for a new feature, please open an issue to discuss it before starting work on it to make sure it aligns with the project roadmap and you don't end up wasting your time.
  • Documentation improvements: See a typo or broken link? Or do you think the documentation could be improved in some other way? Please open an issue to discuss it before making any changes.
  • Code optimizations: If you see a way to improve the code, please open an issue to discuss it before making any changes.

Submitting a Pull Request

We use pull requests to propose changes to the project. The process generally goes like this:

  1. A user opens an issue to discuss a new feature or to report a bug
  2. A maintainer reviews the issue and may label it as status: needs owner
  3. The issues author can volunteer to work on the issue, or someone else can
  4. A maintainer assigns the issue to whoeever volunteers to work on it
  5. The issue owner submits a pull request to address/resolve the issue
  6. A maintainer reviews the pull request and if no changes are needed, merges it into the main repository

Note: Do not submit a pull request until a relevant issue has been opened and assigned to you, otherwise, you may end up wasting time on work that may not be merged into the project.

To volunteer to solve someone else's issue, please leave a comment on the issue to let us know that you'd like to work on it, along with a brief description of how you plan to address the issue.

License

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