Skip to content

Contributing to MAESon 🤝🚀

Thank you for your interest in contributing to MAESon! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and discussions.

How to Contribute 📌

1. Fork the Repository

Click the Fork button at the top of the MAESon GitHub repository, and clone it to your local machine: 

1
2
git clone https://github.com/yourusername/MAESon.git
cd MAESon

2. Create a Branch

Create a new branch for your feature or bug fix: 

1
git checkout -b feature-xyz

3. Install Dependencies

Ensure you have all necessary dependencies installed: 

1
pip install -r requirements.txt
For development, install additional dependencies: 
1
pip install -r requirements-dev.txt

4. Make Your Changes

Modify the codebase and test your changes. If adding a new feature, update the documentation accordingly.

5. Run Tests ✅

Ensure all tests pass before submitting a pull request: 

1
pytest

6. Commit and Push Changes

1
2
3
git add .
git commit -m "Add feature XYZ"
git push origin feature-xyz

7. Submit a Pull Request

Go to the MAESon repository on GitHub, navigate to the Pull Requests tab, and submit a new pull request. Provide a clear description of the changes you've made.

Reporting Issues 🐞

If you encounter a bug, please report it by opening an issue on GitHub Issues. Provide as much detail as possible, including: - Steps to reproduce the issue - Expected behavior - Actual behavior - Screenshots or error logs (if applicable)

Code Style Guidelines ✨

  • Follow PEP 8 for Python code style.
  • Use type hints where applicable.
  • Write docstrings for all functions and classes.

Documentation Contributions 📖

We also welcome contributions to our documentation! If you'd like to improve or add new sections, edit the markdown files in the docs/ directory and submit a pull request.

Join the Discussion 💬

Want to discuss a feature before implementing it? Join the Discussions tab or open an issue to propose new ideas!

🚀 Thank you for contributing to MAESon! Your support helps make geospatial AI more accessible and powerful.