first commit

AGENTS.md

@@ -0,0 +1,40 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+This repository is currently empty (no source, tests, or assets are present). When adding code, keep a simple, discoverable layout such as:
+- `src/` for application/library code
+- `tests/` or `__tests__/` for automated tests
+- `assets/` for static files (images, fixtures)
+Keep top-level docs like `README.md` and `AGENTS.md` in the root.
+
+## Build, Test, and Development Commands
+No build or test scripts are defined yet. When you add tooling, document the exact commands in `README.md` and keep them consistent. Examples you may add later:
+- `npm run dev` for local development
+- `npm test` or `pytest` for running tests
+- `make build` for production builds
+
+## Coding Style & Naming Conventions
+No style configuration is present. When initializing the project, standardize and document:
+- Indentation (e.g., 2 spaces for JS/TS, 4 for Python)
+- Naming patterns (e.g., `camelCase` for functions, `PascalCase` for classes)
+- Formatters/linters (e.g., Prettier, ESLint, Black, Ruff)
+Add config files (like `.editorconfig`, `.prettierrc`, or `pyproject.toml`) and keep them in version control.
+
+## Testing Guidelines
+No testing framework is configured yet. When you add tests:
+- Co-locate tests under `tests/` or alongside modules (e.g., `src/foo.test.ts`)
+- Use clear, descriptive test names
+- Ensure tests run with a single command and include it in `README.md`
+
+## Commit & Pull Request Guidelines
+No Git history is available to infer conventions. Use clear, imperative commit messages (e.g., “Add event model”).
+For pull requests, include:
+- A short summary of changes
+- Linked issue or requirement if available
+- Screenshots or logs for UI/behavior changes
+
+## Security & Configuration Tips
+If you add secrets or environment settings, use a `.env.example` and keep real secrets out of the repo. Document required environment variables in `README.md`.
+
+## Agent Instructions
+Update `README.md` whenever you change workflows, setup steps, environment variables, or Docker behavior so future sessions stay aligned. This file (`AGENTS.md`) provides the contributor guide and lightweight rules for agents working in the repo.