Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 3.97 KB

Contributing to Filigran-UI

Thank you for considering contributing to Filigran-UI! We appreciate your interest in improving the project, and any contributions are welcome, whether you're fixing bugs, suggesting new features, enhancing documentation, or even just reporting issues.

This guide will help you understand how you can contribute and make sure that your efforts align with our goals.

Why Contribute?

Filigran-UI is an open-source design system and component library created to help developers and designers build beautiful, accessible, and flexible user interfaces with ease. By contributing, you can help grow the tool that others rely on to streamline their UI development process.

Benefits of Contributing:

  • Shape the future of the library: You can directly influence the direction of Filigran-UI by adding components or improving existing ones that best suit your needs.
  • Learn and grow: It's a great opportunity to work with modern technologies like React, TypeScript, or other relevant front-end frameworks and libraries.
  • Community-driven: You'll be part of a growing community that strives to create better user interfaces for everyone.

How Can You Contribute?

There are many ways to contribute to Filigran-UI, and you don't have to be a coding expert to help out!

1. Reporting Bugs

If you find a bug, please open an issue and include as much detail as possible:

  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Screenshots, if applicable.
  • Your browser and system details.

2. Suggesting Features

Have a new feature idea or an improvement suggestion? We'd love to hear it! Please check existing feature requests first, and if it's not already discussed, feel free to open a feature request.

3. Contributing Code

We welcome code contributions in various forms, whether it's fixing bugs, building new components, or refactoring existing ones.

How to Get Started:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Make your changes and write appropriate tests for them.
  4. Push your branch: git push origin feature-name.
  5. Open a pull request following the template provided.

4. Improving Documentation

If you find unclear or outdated documentation, help us improve it! You can submit documentation fixes the same way as code contributions—by opening a pull request.

5. Reviewing and Triage

You can assist by reviewing open issues, providing additional information, or suggesting workarounds. Helping triage issues is just as valuable as coding.

Code Standards

We maintain certain guidelines to ensure consistency across the codebase:

  • Code formatting: Use Prettier and ESLint for code linting and formatting.
  • Commit messages: Follow this format: [project] Your message here (#issue-number). Projects can be:
    • filigran-ui
    • filigran-icon
    • filigran-website

Code of Conduct

We are committed to providing a welcoming and respectful environment for everyone. By participating in this project, you agree to uphold our Code of Conduct.

Where Is the Project Heading?

Our current goals for Filigran-UI are:

  • Continuously improving accessibility across all components.
  • Expanding the component library with more customizable and performant components.
  • Strengthening theming capabilities to support various design systems.

We welcome community-driven features and ideas that help Filigran-UI grow into a versatile and comprehensive UI library.

Getting Help

If you have any questions or need support, please open a discussion or an issue. We're here to help!

By following this guide, you'll help us maintain the quality and direction of Filigran-UI. Thanks again for your interest in contributing! We're excited to see what you bring to the project.