Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 2.78 KB

Contributing

Thanks for your interest in contributing to ui.melanyss.me. I'm happy to have you here.

Please take a moment to review this document before submitting your first pull request. I strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

If you need any help, feel free to reach out to @melanysft.

Structure

This repository is structured as follows:

ui-components
├── src
└── public

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine

git clone https://github.com/your-username/ui.git

Navigate to project directory

cd ui-components

Create a new Branch

git checkout -b my-new-branch

Install dependencies

npm install

Documentation

Documentation is written using MDX. You can find the documentation files in the apps/www/content/docs directory.

When adding or modifying components, please ensure that:

  1. You make the changes for every style.
  2. You update the documentation.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Requests for new components

If you have a request for a new component, please open a discussion on GitHub. I'll be happy to help you out.

Testing

Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.

TODOs

Improvements and enhancements:

  1. Implement a search functionality to help users find specific elements quickly.
  2. Add a dark mode toggle for better accessibility and user preference.
  3. Implement a tagging system for easier categorization and filtering of elements.
  4. Add a "Favorites" feature so users can save their most-used elements.
  5. Implement a color picker for gradients and backgrounds, allowing users to customize colors before copying.
  6. Add a preview feature that renders the copied code in real-time.
  7. Implement a versioning system to track changes and updates to the design elements.
  8. Add a community contribution feature, allowing users to submit their own design elements.
  9. Implement keyboard shortcuts for faster navigation and copying.
  10. Add a "Related Elements" section in the modal to suggest similar or complementary design elements.