Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 1.98 KB

File metadata and controls

77 lines (57 loc) · 1.98 KB

Contributing to Drag UI

Thank you for your interest in contributing to Drag UI! We welcome all contributions, whether they are bug fixes, new features, documentation improvements, or suggestions.

How to Contribute

  1. Fork the Repository
    Click the "Fork" button at the top right of this repository page to create your own copy.

  2. Clone Your Fork

    git clone https://github.com/<your-username>/drag-ui.git
    cd drag-ui
  3. Create a Branch
    Use a descriptive branch name:

    git checkout -b feature/your-feature-name
  4. Install Dependencies

    npm install
  5. Make Your Changes

    • Follow the existing code style and conventions.
    • Add or update tests as needed.
    • Update documentation if your changes affect usage.
  6. Run Build

    npm run build
  7. Commit Your Changes
    Use clear and descriptive commit messages:

    git add .
    git commit -m "Add: short description of your change"
  8. Push to Your Fork

    git push origin feature/your-feature-name
  9. Open a Pull Request

    • Go to the original repository on GitHub.
    • Click "Compare & pull request".
    • Fill in the PR template and describe your changes.

Code Style

  • Use Prettier for code formatting.
  • Use ESLint for linting.
  • Write clear, concise, and well-documented code.
  • Use TypeScript for all components.

Commit Message Guidelines

  • Use Conventional Commits:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • refactor: for code refactoring
    • test: for adding or updating tests
    • chore: for maintenance

Reporting Issues

If you find a bug or have a feature request, please open an issue and provide as much detail as possible.

Thank you for helping make