CityTrack / .github /CONTRIBUTING.md
0xarchit's picture
Initial commit: CityTrack MVP with documentation, templates, and license
15cfc64

Contributing to CityTrack

Thank you for your interest in contributing to CityTrack! We welcome all contributions to help improve urban infrastructure reporting.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/0xarchit/CityTrack.git
  3. Create a feature branch: git checkout -b feature/your-feature
  4. Make your changes
  5. Push to your branch and open a Pull Request

Development Setup

git clone https://github.com/0xarchit/CityTrack.git
cd CityTrack
docker-compose up -d
npm install && pip install -r requirements.txt

Code Style

  • Follow PEP 8 for Python code
  • Use ESLint for JavaScript/TypeScript
  • Write clear, meaningful commit messages
  • Add tests for new features

Pull Request Process

  1. Update documentation if applicable
  2. Add tests for new functionality
  3. Ensure all tests pass locally
  4. Provide a clear description of changes
  5. Reference any related issues

Reporting Bugs

Use GitHub Issues to report bugs. Include:

  • Clear description of the bug
  • Steps to reproduce
  • Expected vs. actual behavior
  • System information

Suggesting Features

We're open to new ideas! Create an issue with:

  • Clear feature description
  • Use cases
  • Any implementation suggestions

Questions?

Feel free to open a discussion or issue if you have questions. We're here to help!


Built by BitBots | Team Lead: @0xarchit