Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 2.7 KB

Contributing to Svelvunity

Thank you for considering contributing to Svelvunity! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue on our GitHub repository and describe your idea in detail.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes.
  4. Ensure your code follows our coding standards and passes all tests.
  5. Commit your changes with a clear and descriptive message.
  6. Push your branch to your forked repository.
  7. Open a pull request on our GitHub repository.

Code Style

Please follow our coding standards:

  • Use meaningful variable and function names.
  • Write comments to explain complex code.
  • Format your code.

Testing

Ensure your changes pass all tests. If you add new features, please include tests for them using Vitest.

Documentation

Update the documentation to reflect your changes. This includes the README file and any other relevant documentation files.

Project Overview

Svelvunity is a UI component library built with Svelte components and Tailwind CSS that helps developers build websites faster. By leveraging this library, developers can significantly reduce the time and effort required to build UI elements for their projects. Instead of starting from scratch, they can integrate ready-made components into their applications, saving valuable development time and resources.

Getting Started

If you wish to experiment with Svelvunity on your local machine:

For more information on the various commands you can run locally, please refer to the DEVELOPER documentation.

Additional Resources

The Open Source Guides website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful:

Thank you for your contributions! ❤️