Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 7 additions & 55 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,12 @@
# Contributing to OpenSprout

Thanks for helping grow OpenSprout. Beginners, docs fixes, design feedback, bug reports, and careful plant-care nerd notes are all welcome.
Please see [docs/Contributing.md](docs/Contributing.md) for the full contributing guide.

## Ways to Contribute
## Quick Links

- Report bugs.
- Suggest features.
- Improve documentation.
- Pick up `good first issue` tasks.
- Add tests and accessibility improvements.
- Improve self-hosting and privacy docs.
- [Development Setup](docs/Development.md)
- [Architecture](docs/Architecture.md)
- [Deployment](docs/Deployment.md)
- [Testing](docs/Testing.md)

## Development Setup

```bash
npm install
cp .env.example apps/web/.env.local
npm run dev
```

Add your Supabase project URL and publishable key to `apps/web/.env.local` when working on authenticated or database-backed flows. Never use a Supabase service role key in frontend environment variables.

## Branches and Commits

Use descriptive branches such as:

- `feature/plant-profiles`
- `fix/reminder-timezone`
- `docs/self-hosting-guide`

Suggested commit prefixes:

- `feat:`
- `fix:`
- `docs:`
- `test:`
- `refactor:`
- `chore:`

## Pull Requests

- Keep PRs focused.
- Explain what changed and why.
- Link related issues.
- Include screenshots for UI changes.
- Add or update tests when behavior changes.
- Mention privacy, accessibility, or self-hosting impact when relevant.

## Design Principles

- Privacy-first.
- Self-hostable by default.
- Accessible and mobile-friendly.
- Beginner-friendly without hiding useful detail.
- No subscriptions, trackers, or lock-in.

## Security

Please do not open public issues for sensitive vulnerabilities. Follow the disclosure process in [SECURITY.md](SECURITY.md).
By contributing, you agree that your contributions will be licensed under AGPLv3.
Loading
Loading