Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 2.14 KB

File metadata and controls

79 lines (54 loc) · 2.14 KB

Contributing to CollabCanvas

Thank you for your interest in contributing! 🎉
We welcome all kinds of contributions: bug fixes, new features, documentation improvements, and more.

How to Contribute

  1. Fork the repository
    Click the "Fork" button at the top right of the GitHub page.

  2. Clone your fork

    git clone https://github.com/your-username/collab-canvas.git
    cd collab-canvas
  3. Create a new branch

    git checkout -b feature/your-feature-name
  4. Make your changes
    Please follow the existing code style and add tests if applicable.

  5. Commit your changes

    git commit -m "feat: Brief description of your change"
  6. Push your branch

    git push origin feature/your-feature-name
  7. Open a Pull Request
    Go to the original repository and click "Compare & pull request".
    Fill in a clear title and description. If your change affects the UI, please include screenshots.

Branch Name Convention

  • Use short, descriptive names.
  • For features: feature/your-feature-name
  • For bug fixes: fix/short-description
  • For documentation: docs/short-description

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 tasks
  • Example:
    feat: add shape drawing tool

Code Style

  • Use Prettier for formatting.
  • Write clear, descriptive commit messages.
  • Keep pull requests focused and small.

Reporting Issues

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

Community

Be respectful and constructive in all interactions.
We follow the Contributor Covenant Code of Conduct.


Thank you for helping make CollabCanvas better! 🚀