Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

60 lines (48 loc) · 2.94 KB
Raw

Contributing to FlyonUI

We welcome contributions from the community! Whether you're reporting bugs, suggesting new features, or fixing issues, your help is appreciated 🤝

Reporting Issues

  • Before opening a new issue, please first search for existing issues to avoid duplicates.
  • Provide detailed reports with as much context as possible, including steps to reproduce the issue, your environment, and any relevant logs or screenshots.
  • For hard-to-reproduce bugs, please include a minimal reproducible repository or detailed steps to recreate the issue.

Fixing Existing Issues

  • Help us by fixing existing issues.
  • Avoid working on issues already assigned to others to prevent duplicate efforts.
  • If you're interested in working on an issue, please add a comment to request assignment before starting work. This helps maintainers track who's working on what and prevents duplication of effort.
  • Use the following commit message format for fixes: fix: #<issue_number> [description]. This automatically closes the issue and adds the fix to the changelog upon release.

Feature Requests

  • If you have an idea you'd like to discuss with the community, please open a discussion.
  • Please note that not all feature requests will be accepted, as some may not align with the vision or scope of the library. Don’t take it personally if a request is rejected.

Pull Requests

  • Pull requests should address an open issue that is assigned to you. If no issue exists, create one first. If an issue is not assigned to you, please request assignment in the comments before submitting a PR. This ensures we avoid duplicate efforts.
  • For minor changes like fixing typos, an issue is not required. Feel free to directly open a pull request.
  • For documentation fixes, including updates to the website, you can also submit a pull request without opening an issue first.

Local Development Setup

To build the FlyonUI package locally, follow these steps:

  1. Fork the repository and clone it to your local machine. 
    git clone https://github.com/your-username/flyonui.git
  2. Install the necessary package dependencies: 
    npm install
  3. Build the package: 
    npm run dist
  4. You can now import FlyonUI into your tailwind.config.js: 
    module.exports = {
  content: [
    "/path/to/dist/js/*.js" // for JS components
  ],
  plugins: [
    require("/path/to/src/index"),
    require("/path/to/plugin") // for JS components
  ],
};
  5. Finally, include the flyonui.js file in your HTML: 
    <script src="/path/to/flyonui.js"></script>