> For the complete documentation index, see [llms.txt](https://docs.openagrinet.global/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openagrinet.global/technical/contributing-md.md).

# 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

<table><thead><tr><th width="288.39996337890625">Repo</th><th>Repo Link</th></tr></thead><tbody><tr><td>Provider Service Repo</td><td><a href="https://github.com/OpenAgriNet/OAN-Provider-Service">https://github.com/OpenAgriNet/OAN-Provider-Service</a></td></tr><tr><td>Seeker Service Repo</td><td><a href="https://github.com/OpenAgriNet/OAN-Seeker-Service">https://github.com/OpenAgriNet/OAN-Seeker-Service</a></td></tr><tr><td>Seeker UI Repo</td><td><a href="https://github.com/OpenAgriNet/OAN-Seeker-UI">https://github.com/OpenAgriNet/OAN-Seeker-UI</a></td></tr></tbody></table>

#### 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](https://github.com/OpenAgriNet/oan-project/issues) 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openagrinet.global/technical/contributing-md.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
