The Atlas MikeOSS.Azure's docs, bound to the code — and to the migration that built it
108 documents
CONTRIBUTING.md

Short contribution policy: keep PRs small and focused, prefer targeted edits over broad refactors, update docs/env examples alongside behavior changes, and never commit secrets or .env files. It explicitly asks contributors not to propose local-hosting refactors of the main app (local LLMs/DBs/filesystem storage are deferred to a future fully-local version), points security reports to GitHub private vulnerability reporting, and gives the per-area build commands (npm run build --prefix backend / frontend). Read before opening a PR to match the project's scope, review, and security-reporting expectations.

Contributing

Thanks for helping improve Mike. Please keep contributions small, focused, and easy to review.

Guidelines

  • Prefer targeted edits over broad refactors.
  • Keep each PR focused on one bug, feature, or cleanup.
  • Update docs or env examples when changing setup, config, or user-facing behavior.
  • Please do not propose local-hosting refactors for the main app, such as local LLMs, local databases, or local filesystem storage. Those ideas are better suited to a future fully local version of the project.
  • Do not commit secrets, API keys, private documents, or local .env files.

Before Opening a PR

  • Run the relevant build or test command for the area you changed.
  • Check git diff and remove unrelated changes.
  • Write a concise Markdown PR description with:
    • summary
    • changes
    • why
    • testing

Security

Do not open a public issue for security vulnerabilities. Use GitHub's private vulnerability reporting instead.

We will aim to respond promptly and coordinate a disclosure timeline with you.

Local Development

Backend:

npm run build --prefix backend

Frontend:

npm run build --prefix frontend