Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (64 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

90 lines (64 loc) · 2.07 KB

Contributing to Loopin City

Thank you for your interest in contributing to Loopin City! This document provides guidelines and instructions for contributing to our project.

Code of Conduct

Please read and follow our Code of Conduct before contributing.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in the Issues section
  • Use the bug report template when creating a new issue
  • Include detailed steps to reproduce the bug
  • Include screenshots if applicable
  • Specify your environment (browser, OS, etc.)

Suggesting Features

  • Check if the feature has already been suggested
  • Use the feature request template
  • Provide a clear description of the feature
  • Explain why this feature would be useful
  • Include any relevant mockups or examples

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Run tests and linting
  5. Submit a pull request

Development Workflow

  1. Setup:

    git clone https://github.com/Loopin-city/loopin-city.git
cd loopin-city
npm install

  2. Create a new branch:

    git checkout -b feature/your-feature-name

  3. Make your changes

  4. Run tests and linting:

    npm run lint

  5. Commit your changes:

    git commit -m "Description of your changes"

  6. Push to your fork:

    git push origin feature/your-feature-name

  7. Create a Pull Request

Code Style

  • Follow the existing code style
  • Use TypeScript for type safety
  • Follow React best practices
  • Use TailwindCSS for styling
  • Write meaningful commit messages

Documentation

  • Update documentation for any new features
  • Keep the README up to date
  • Document any breaking changes

Getting Help

License

By contributing to Loopin City, you agree that your contributions will be licensed under the project's MIT License.