Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.97 KB
Raw

🤝 Contributing to PMAI

Thank you for your interest in contributing to the Intelligent Agroecological Monitoring Platform (PMAI)! We believe that open-source collaboration is key to building sustainable and accessible AgTech solutions for Latin America.

This document provides guidelines for contributing to the project. By participating, you agree to uphold a respectful and inclusive environment.

📋 Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Coding Standards
  5. Pull Request Process

🛡️ Code of Conduct

We are committed to providing a welcoming and inspiring community. Please be respectful, constructive, and inclusive in all interactions, issues, and pull requests.

🛠️ How Can I Contribute?

🐛 Reporting Bugs

If you find a bug, please open an issue using the Bug Report template. Include:

  • A clear and descriptive title.
  • Steps to reproduce the behavior.
  • Expected vs. actual behavior.
  • Screenshots or logs if applicable.

💡 Suggesting Features

We love new ideas! Especially regarding Qwen AI integration, IoT optimizations, or UI/UX improvements for rural users. Open an issue using the Feature Request template.

🧑‍💻 Writing Code

Look for issues labeled good first issue or help wanted. Comment on the issue to let us know you are working on it before submitting a PR.

💻 Development Setup

  1. Fork the repository and clone your fork:
git clone https://github.com/YOUR-USERNAME/pmai-mvp.git
cd pmai-mvp
  1. Set up the backend (Python/FastAPI) and frontend (React/Vite) as described in the README.md
  2. Create a new branch for your feature or bugfix:
git checkout -b feat/your-feature-name
# or
git checkout -b fix/your-bugfix-name

📏 Coding Standards

To maintain code quality, please adhere to the following standards:

  • Python (Backend): Follow PEP 8 Use black for formatting and flake8 for linting.
  • TypeScript/JavaScript (Frontend): Follow the project's eslint and prettier configurations.
  • Commits: Use Conventional Commits (e.g., feat: add soil moisture chart, fix: resolve login redirect).
  • Documentation: Update the README.md or inline code comments if your change affects functionality.

🚀 Pull Request Process

  1. Ensure your code passes all local tests and linting checks.
  2. Update the README.md or documentation if necessary.
  3. Submit a Pull Request to the main branch.
  4. In the PR description, clearly explain:
    • What problem this PR solves or what feature it adds.
    • How to test the changes.
    • Reference any related issues (e.g., Closes #12).
  5. Wait for a maintainer to review your PR. Be open to feedback and make requested changes.

🌟 Thank You!

Every contribution, no matter how small, helps make PMAI a better tool for sustainable agriculture. Thank you for being part of this journey! 🌱