Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
248 lines (188 loc) · 6.96 KB

CONTRIBUTING.md

File metadata and controls

248 lines (188 loc) · 6.96 KB

Contributing to Pollinator-Integrated Vegetable Farming

Thank you for your interest in contributing! This repository welcomes contributions from farmers, researchers, developers, and anyone passionate about sustainable agriculture and pollinator conservation.

🎯 Types of Contributions Welcome

👨‍🌾 Farmers & Practitioners

  • Share your own case studies and experiences
  • Report what worked (and what didn't) on your farm
  • Provide practical insights and lessons learned
  • Suggest improvements based on real-world experience

🔬 Researchers & Data Scientists

  • Add new research findings and citations
  • Contribute economic analysis or data
  • Share academic studies on pollinator-crop relationships
  • Improve data visualization and analysis

💻 Developers & Technical Contributors

  • Improve the Python analysis scripts
  • Enhance data processing workflows
  • Create data visualization tools
  • Help with repository infrastructure

📝 Writers & Communicators

  • Improve documentation clarity
  • Add translations to other languages
  • Create FAQ sections or guides
  • Enhance readability and accessibility

🐝 Educators

  • Develop training materials
  • Create educational resources
  • Add teaching modules
  • Share curriculum ideas

🚀 How to Contribute

Step 1: Fork the Repository

Click the Fork button on the GitHub repo page to create your own copy.

Step 2: Clone Your Fork

git clone https://github.com/YOUR-USERNAME/Pollinator-Integrated-Vegetable-Farming.git
cd Pollinator-Integrated-Vegetable-Farming

Step 3: Create a Feature Branch

Use a descriptive branch name:

git checkout -b feature/add-kenya-case-study
git checkout -b docs/improve-implementation-guide
git checkout -b data/economic-analysis-2026

Branch naming conventions:

  • feature/ - New case studies or content
  • docs/ - Documentation improvements
  • data/ - Data files or analysis
  • fix/ - Bug fixes or corrections

Step 4: Make Your Changes

Edit files, add content, or improve existing material.

Step 5: Commit Your Changes

Write clear, descriptive commit messages:

git commit -am "Add case study from Kenya beekeeping project"
git commit -am "Fix broken links in full report"
git commit -am "Update economic data with 2026 figures"

Step 6: Push to Your Fork

git push origin feature/add-kenya-case-study

Step 7: Create a Pull Request

  1. Go to the original repository: https://github.com/MattWingy/Pollinator-Integrated-Vegetable-Farming
  2. Click "New Pull Request" button
  3. Select your fork and branch
  4. Write a clear description of your changes
  5. Click "Create Pull Request"

📋 Pull Request Guidelines

Please include:

  • Title: Brief, clear summary (e.g., "Add case study from Tanzanian beekeeping cooperative")
  • Description: Explain what you're contributing and why
  • Type: Is this a new case study, data, documentation, or code improvement?
  • References: Link to any relevant sources or issues
  • Testing: For code, describe how you tested it

Example PR Description:

## Description
Adding a case study from a beekeeping cooperative in Tanzania that successfully integrated pollinator farming with vegetable production.

## Type of Change
- [x] New case study
- [ ] Data update
- [ ] Documentation
- [ ] Code improvement

## Sources
- Interview with cooperative manager (Jan 2026)
- Project report: [link]
- Publication: Author et al. (2025)

## Additional Context
This case study demonstrates successful integration in East Africa and provides income comparison data for smallholder farmers.

📝 Content Guidelines

Case Studies

When adding a new case study, include:

  • Location: Country and region
  • Farm type: Scale, crops, main activities
  • Pollinator approach: Beekeeping, habitat, or integrated
  • Duration: How long has it been running?
  • Results: Quantified outcomes (yield %, income, biodiversity)
  • Challenges: What difficulties were faced?
  • Lessons learned: Key insights
  • Sources: Where did you get this information?

Format:

## 🇰🇪 Case Study: Kenyan Smallholder Beekeeping Network

### Location
Western Kenya, Kisii County

### Operation Details
- Farm size: 2-5 acres per farmer
- Crops: Maize, beans, vegetables
- Hives: 3-8 per farmer
- Started: 2023

### Results
- Honey income: $400-600 per farmer annually
- Crop yield increase: 25-35%
- Farmer retention: 95%

### Key Lessons
[...]

### Sources
- Interview with network coordinator (Jan 2026)
- Project monitoring data (2023-2026)

Data Contributions

  • Include CSV files with clear headers
  • Provide a README explaining the data
  • Cite original sources
  • Include methodology notes if applicable
  • Use consistent formatting

Documentation Improvements

  • Fix typos and clarity issues
  • Add section headings where helpful
  • Improve formatting for readability
  • Add links to related sections
  • Keep tone consistent with existing docs

Code Contributions

  • Follow PEP 8 style guide for Python
  • Include comments explaining complex logic
  • Add docstrings to functions
  • Test your code before submitting
  • Keep changes focused on one issue

✅ Review Process

  1. Automated checks: GitHub will run basic validation
  2. Community review: Other contributors may provide feedback
  3. Maintainer review: MattWingy or designated reviewers will evaluate
  4. Revisions: You may be asked to make adjustments
  5. Approval & merge: Once approved, your contribution is merged!

This usually takes 3-7 days, but we aim to be prompt.

🙏 Code of Conduct

All contributors agree to:

  • ✅ Be respectful and inclusive
  • ✅ Welcome diverse perspectives
  • ✅ Give credit to others' work
  • ✅ Focus on the goal of sustainable agriculture
  • ✅ Provide constructive feedback

We have zero tolerance for:

  • ❌ Harassment or discrimination
  • ❌ Plagiarism or intellectual property violations
  • ❌ Disruptive behavior
  • ❌ Spam

📞 Questions or Need Help?

  • Issues: Have a bug report or feature idea? Open an issue
  • Discussions: Want to discuss ideas first? Use Discussions
  • Email: Contact the maintainers for specific questions

🌟 Recognizing Contributors

We recognize all contributions! Contributors will be:

  • Listed in the repository
  • Credited in relevant sections
  • Mentioned in release notes
  • Acknowledged in the project's README

📚 Additional Resources

🐝 Thank You!

Every contribution—no matter the size—helps build better resources for sustainable pollinator farming. We're grateful for your support!

Happy contributing! 🌾🐝

Last updated: January 2026