Merge pull request #9 from openagri-eu/readme

Author: JoleVLF

CONTRIBUTE.md

@@ -0,0 +1,73 @@
+# Contributing to Reporting Service
+
+We’re excited that you’re interested in contributing to Reporting Service! 🎉
+This project is licensed under the EUPL v1.2 and welcomes contributors of all backgrounds and experience levels.
+
+## 🚀 How to Contribute
+
+### Fork & Clone
+
+- Fork the repository on GitHub.
+
+- Clone your fork locally:
+
+        git clone https://github.com/your-username/reporting-service.git
+        cd reporting-service
+
+### Create a Branch
+
+Always create a new branch for your work:
+
+    git checkout -b feature/my-new-feature
+
+### Make Your Changes
+
+Add or update tests when making changes.
+
+### Commit & Push
+
+Write clear, descriptive commit messages:
+
+    git commit -m "Add support for caching pdf reports"
+    git push origin feature/my-new-feature
+
+### Open a Pull Request
+
+Go to the main repo and open a PR (Pull Request).
+
+Describe:
+
+- What your change does
+
+- Why it’s needed
+
+- Any related issues
+
+Maintainers will review your PR and may request changes. Don’t worry — feedback is part of the process!
+
+
+### 📝 Reporting Issues
+
+Check the issue tracker first.
+
+If not already reported, open a new issue with:
+
+-  A clear description
+
+-  Steps to reproduce (if a bug)
+
+-  Expected vs actual behavior
+
+### 🌱 First-Time Contributors
+
+We especially welcome first-time contributors! Some good first steps:
+
+Look for issues labeled good first issue.
+
+Improve documentation (typos, examples, guides).
+
+Add tests for untested parts of the code.
+
+### 🙏 Acknowledgments
+
+Every contribution — big or small — matters. Thank you for helping improve!

README.md

@@ -6,6 +6,14 @@
 The reporting service generates .pdf reports based on information present in datasets.\
 These datasets are required to conform to the OCSM (OpenAgri Common Semantic Model) as well as be JSON-LD compliant.
 
+# Roadmap
+
+High-level next steps for the Reporting Service:
+
+- [ ] Implement PDF reports for irrigation fertilization
+- [ ] Integrate with additional 3rd party Open Street Maps API for satelite images
+- [ ] Update PDF reports design and tables to be more adaptive for different use cases
+ 
 # Requirements
 <ul>
     <li>git</li>
@@ -214,8 +222,15 @@ This will run the tests and return success values for each api tested in the ter
 
 <h3>These tests will NOT result in generated .pdf files.</h3>
 
-# Contribution
-Please contact the maintainer of this repository.
+## Contributing
+
+We welcome first-time contributions!
+
+See our [Contributing Guide](CONTRIBUTE.md)
+
+You can also open an issue to discuss ideas.
+
+Reporting Service is part of OpenAgri project, building tools for agriculture & climate data. Your contribution helps farmers and researchers.
 
 # License
 This project code is licensed under the EUPL 1.2 license, see the [LICENSE](https://github.com/agstack/OpenAgri-ReportingService/blob/main/LICENSE) file for more details.