Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 3.25 KB
Raw

Contributing to aerial2map

Thank you for your interest in contributing to aerial2map! We’re excited to collaborate with developers and AI enthusiasts to improve this project. Whether you’re fixing bugs, adding new features, or improving documentation, your contributions are greatly appreciated.

Getting Started

  1. Fork the Repository: Start by forking the repository to make changes in your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/aerial2map.git
cd aerial2map

  3. Set Up the Environment: Ensure that you have Python and the required dependencies installed. Install dependencies using:

    pip install -r requirements.txt

  4. Create a Branch: For each feature or bug fix, create a new branch.

    git checkout -b feature-name

  5. Make Changes: Implement your changes in the project, following best practices and keeping code quality in mind.

  6. Run Tests: Test your changes locally to confirm they work as expected. You can do this using the Streamlit app or by running individual scripts.

  7. Commit and Push: Commit your changes with a clear message, then push your branch to your forked repository.

    git add .
git commit -m "Brief description of your changes"
git push origin feature-name

  8. Create a Pull Request: Go to the original repository on GitHub, navigate to the "Pull Requests" section, and create a pull request (PR) from your fork.

Contribution Guidelines

Code Style

  • Follow PEP 8 guidelines for Python code.
  • Use clear and descriptive variable names.
  • Keep functions small and focused on a single task.

Adding New Features

If you’re planning to add a significant feature, please open an issue to discuss your idea with the maintainers. This helps to avoid duplicate efforts and ensures alignment with the project’s goals.

Reporting Bugs

  1. Check the issue tracker to see if the bug has already been reported.
  2. If not, create a new issue and include:
    • A clear description of the bug.
    • Steps to reproduce the bug.
    • Your system configuration, including Python and dependency versions.

Suggesting Enhancements

We welcome suggestions to improve the project. Please open an issue with your enhancement proposal, including:

  • A description of the feature.
  • How it would benefit users or improve the project.
  • Any additional context or links to related discussions or resources.

Documentation

Improving documentation is a great way to contribute! Feel free to correct typos, add explanations, or expand on examples in the README or other documentation files.

License

By contributing to this project, you agree that your contributions will be licensed under the repository’s MIT License.

Code of Conduct

Please adhere to our Code of Conduct in all interactions. We strive to maintain a welcoming and inclusive community.

Thank you for your contributions! We appreciate your support in improving the aerial2map project. If you have any questions, feel free to reach out by opening an issue on GitHub.