Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

53 lines (44 loc) · 1.48 KB

Contributing to this project

Thank you for your interest in contributing! Here are some guidelines to help you get started.

How to Contribute

  • Developing and testing

    • Clone repository
    • Change dir into frontend folder:
    cd frontend
    bun i
    • Start local development:
      • manually:
      bun run dev --host
      • OR use docker:
      docker compose up --build
    • Test, make changes, and explore improvements:
      • Intentionally break components to identify edge cases or areas for enhancement.
      • Document your findings and potential fixes.
  • Reporting Bugs

    • Check if the issue has already been reported.
    • Open a new issue with detailed information.
  • Suggesting Enhancements

    • Discuss your ideas on the issues page.
    • Be clear and concise in your suggestions.
  • Submitting Pull/Merge Requests

    • Fork the repository.
    • Create a new branch for your feature or fix (preferably with name close to feature/[issue-number]-shortDescriptionOfIssue if possible).
    • Ensure your code follows the project's coding standards.
    • Submit a pull/merge request with a clear description.

Code Style

  • Use meaningful variable and function names.
  • Write comments where necessary.
  • Follow the existing code formatting.

Communication

  • Be respectful and professional.
  • Provide constructive feedback.
  • Be open to discussions and suggestions.