Welcome, and thank you for your interest in contributing to Fieldly! We're building a revolutionary platform at the intersection of regenerative agriculture and financial technology, designed to empower farmers, connect institutional investors, and create a sustainable future. Your contributions whether code, design, documentation, or ideas play a crucial role in shaping that vision.
This guide outlines how both new and experienced contributors can get involved: from reporting bugs and suggesting new features to improving documentation or contributing production-ready code. Whether you're fixing a typo or architecting a major feature, every contribution helps strengthen the Fieldly ecosystem.
Audience: Developers, designers, financial analysts, agricultural experts, writers, and community members who want to help make Fieldly better.
- Code of Conduct
- How Can I Contribute?
- Getting Started (Local Development)
- Project Structure
- Branching & Workflow
- Commit Message Convention
- Coding Style & Linting
- Testing
- Review Process
- Security & Responsible Disclosure
- License and Copyright
- Acknowledgements & Contacts
This project follows the Contributor Covenant (v2.1) — we expect all community members to be professional, respectful, and inclusive. By participating, you agree to abide by this code. If you experience or witness unacceptable behavior, contact the maintainers immediately (see Acknowledgements & Contacts).
- Check the existing issues to avoid duplicates
- Use the bug report template when creating a new issue
- Include:
- Clear description of the bug
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
- Environment details (OS, browser, Node version)
- Check existing feature requests to avoid duplicates
- Use the feature request template
- Describe:
- The problem you're solving
- Your proposed solution
- Any alternatives considered
- Potential impact on the platform
- Fix typos, improve clarity, or add examples
- Translate documentation
- Create tutorials or guides
- Submit changes via pull request with the
documentationlabel
- Fork the repository
- Create a feature branch
- Write clear, well-documented code
- Add tests if applicable
- Ensure all tests pass
- Submit a pull request using the PR template
We welcome contributions from:
- Agricultural scientists and agronomists
- Financial analysts and economists
- Regenerative farming practitioners
- Climate and environmental specialists
- Supply chain and logistics experts
Contribute through discussions, whitepapers, or domain-specific documentation.
| Tool | Version |
|---|---|
| Node.js | 18+ |
| pnpm | 8+ |
| PostgreSQL | 15+ |
# Clone your fork
git clone https://github.com/YOUR_USERNAME/Fieldly.git
cd Fieldly
# Install dependencies
pnpm install
# Configure environment
cp .env.example .env
# Setup database
pnpm prisma generate
pnpm prisma migrate dev
# Start development server
pnpm dev