Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (32 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.28 KB
Raw

Contributing to AutoData

First off, thank you for considering contributing to AutoData! It's people like you that make AutoData such a great tool.

How can I contribute?

Reporting Bugs

If you find a bug in the source code, you can help us by submitting an issue. Even better, you can submit a Pull Request with a fix.

Suggesting Enhancements

If you have an idea for a feature that would make AutoData even better, please submit an issue. Provide as much detail as possible about what the feature is and how it should work.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes (make test).
  4. Make sure your code lints.
  5. Issue that pull request!

Local Development Setup

To run the project locally for development:

  1. Clone the repository

    git clone https://github.com/JayanGupta/AutoData.git
cd AutoData

  2. Run setup

    make setup

  3. Start the development server

    make dev

  4. The application should now be accessible at http://localhost:3000.

Any questions?

If you have any questions, feel free to open an issue or reach out. We are happy to help!