CONTRIBUTING.md

Thank you for your interest in contributing to OpenAgriNet (OAN)!

OAN is a Digital Public Infrastructure (DPI) initiative to enable interoperable agricultural ecosystems globally. We welcome contributions from developers, data experts, domain specialists, implementers, translators, designers, and anyone passionate about creating open, inclusive, and impactful solutions in agriculture.

This document provides guidelines to help you contribute effectively and respectfully.

📌 Ways to Contribute

We welcome contributions in many forms:

🛠 Code Contributions

• Bug fixes

• New features or enhancements

• API integrations

• Documentation updates for code

📚 Documentation

• Improving technical documentation

• Translating content

• Creating implementation guides and case studies

🌐 Adoption & Implementation Support

• Building pilots or reference implementations

• Sharing real-world use cases

• Providing feedback from field deployments

🎨 Design & UX

• Improving user interfaces

• Creating infographics or architectural diagrams

💬 Community Engagement

• Participating in discussions

• Helping review pull requests

• Organizing meetups or webinars

🧰 Getting Started

1. Fork and Clone the Repository

Repo	Repo Link
Provider Service Repo	https://github.com/tekdi/OAN-Provider-Service
Seeker Service Repo	https://github.com/tekdi/OAN-Seeker-Service
Seeker UI Repo	https://github.com/tekdi/OAN-Seeker-UI/tree/dev

2. Set Up Your Development Environment

Refer to the README.md for setup instructions specific to your area of contribution (e.g., backend, frontend, data models).

✅ Submitting Changes

Code Contributions

• Create a new branch: git checkout -b feature/your-feature-name

• Follow existing coding styles and naming conventions.

• Test your changes before submitting.

• Add clear commit messages.

Pull Requests

• Open a PR to the main branch with a clear description of the change.

• Link to related issues (if any).

• Keep PRs focused and minimal—break them down if needed.

📄 Coding and Contribution Guidelines

• Be respectful in comments and code reviews.

• Document your code and any assumptions.

• Avoid including proprietary or sensitive information.

• Follow the Code of Conduct at all times.

💡 Reporting Issues and Suggestions

Found a bug? Have an idea for improvement? Please open an issue and provide as much context as possible.

Include:

• Steps to reproduce (for bugs)

• Expected vs. actual behavior

• Screenshots or logs (if applicable)

🧾 License

By contributing, you agree that your contributions will be licensed under the same license as the project. Refer to the LICENSE file for more details.

🙏 Thank You

Your contributions help make OpenAgriNet a robust and impactful platform that benefits farmers, governments, innovators, and communities around the world. We deeply appreciate your effort and time.