Contributing to Local Data Platform

We're thrilled that you're interested in contributing to the Local Data Platform! Your help is essential for keeping it great.

This section provides guidelines for contributing to the project. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

How to Get Started

If you're new to the project, the best place to start is the how_to_setup.md guide located in the root of the repository. This will walk you through cloning the project and setting up your local development environment.

Once you're set up, you can explore the other pages in this section to learn how to report issues or request features.

Submitting Pull Requests

We follow a standard "fork and pull" model for contributions. To submit a change, please follow these steps:

1. Create a Fork: Fork the repository to your own GitHub account.
2. Create a Branch: Create a new branch from main in your fork for your changes. Please use a descriptive branch name (e.g., feat/add-new-ingestion-source or fix/docs-build-error).
3. Make Your Changes: Make your changes, ensuring you follow the project's coding style.
4. Run Quality Checks: Before committing, run all the local quality checks to ensure your changes don't introduce any issues.

   make all
   

5. Commit Your Changes: Commit your changes with a clear and descriptive commit message. We follow the Conventional Commits specification.
6. Push to Your Fork: Push your branch to your fork on GitHub.
7. Open a Pull Request: From your fork on GitHub, open a pull request to the main branch of the tusharchou/local-data-platform repository.

Your PR will be reviewed by the maintainers, and once approved, it will be merged. Thank you for your contribution!