Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (31 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.65 KB

Contributing to OperatorOne

Thanks for your interest in contributing! Here's how to get started.

Getting Started

  1. Fork the repo and clone your fork
  2. Copy .env.example to .env
  3. Run ./scripts/start.sh to generate secrets and start the stack
  4. Complete the setup wizard at http://console.localhost

See the README for detailed setup instructions.

Development

# Start the dev stack
docker compose -f docker-compose.yml -f docker-compose.dev.yml \
  -f modules/console/docker-compose.yml -f modules/console/docker-compose.dev.yml \
  -f modules/admin/docker-compose.yml -f modules/admin/docker-compose.dev.yml \
  -f modules/paperless/docker-compose.yml -f modules/paperless/docker-compose.dev.yml \
  up -d

The console app supports hot reload via volume mounts in dev mode.

Pull Requests

  • Create a feature branch from main
  • Keep PRs focused — one feature or fix per PR
  • Include a clear description of what changed and why
  • Make sure the dev stack starts cleanly with your changes

Reporting Bugs

Use the bug report template when filing issues.

Security

Found a vulnerability? Do not open a public issue. Use GitHub's private vulnerability reporting instead. See SECURITY.md for details.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.

License

By contributing, you agree that your contributions will be licensed under the MIT License.