From 2c842b1520308ec03662c43614a165d01648466b Mon Sep 17 00:00:00 2001 From: Aditya Gupta Date: Fri, 10 Jul 2026 07:51:48 +0530 Subject: [PATCH] docs: Added CoC and Contributing guidelines --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 99 +++++++++++++++++++++++++++++++++++ 2 files changed, 227 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..323a70d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +mail@adityagupta.dev. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..19b6d48 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,99 @@ +# Contributing to Omnia + +Thank you for your interest in contributing to Omnia! We welcome contributions from developers, technical writers, and anyone interested in agentic narrative simulation. + +Please take a moment to review this document before submitting contributions. + +## Table of Contents + +1. [Documentation](#documentation) +2. [Getting Started](#getting-started) +3. [Development Workflow](#development-workflow) +4. [Coding Standards](#coding-standards) +5. [Pull Request Guidelines](#pull-request-guidelines) + +## Documentation + +The primary source of truth for the Omnia project is the official documentation: +👉 **[Omnia Documentation](https://omnia.adityagupta.dev/docs)** + +Please refer to the documentation to understand the project architecture, memory model, spatial systems, intents framework, and custom LLM configurations. + +## Getting Started + +Omnia is organized as a monorepo managed with **pnpm** workspaces. + +### Prerequisites + +- **Node.js** (v22.13 or newer recommended) +- **pnpm** (v11 or newer recommended) + +### Local Setup + +1. Fork the repository and clone your fork: + ```bash + git clone https://github.com/YOUR_USERNAME/omnia-consolidated.git + cd omnia-consolidated + ``` +2. Install dependencies: + ```bash + pnpm install + ``` +3. Run the Web GUI interface locally: + ```bash + pnpm dev:gui + ``` +4. Run the Starlight documentation site locally: + ```bash + pnpm dev:docs + ``` + +## Development Workflow + +### Branching + +Create a descriptive branch for your changes: + +```bash +git checkout -b feature/your-feature-name +# or +git checkout -b fix/issue-description +``` + +### Running Tests + +Make sure all unit tests pass before submitting changes: + +```bash +# Run tests once +pnpm test + +# Run tests in watch mode +pnpm test:watch +``` + +### Linting and Formatting + +We enforce consistent code quality and formatting rules across the repository. + +```bash +# Check code style and formatting +pnpm lint +pnpm format:check + +# Auto-fix code style issues +pnpm lint:fix +pnpm format +``` + +## Coding Standards + +- **TypeScript**: Omnia is written entirely in TypeScript. Ensure all new code is strongly typed. +- **Docstrings**: Document public-facing APIs, methods, and configurations. + +## Pull Request Guidelines + +1. **Keep PRs Focused**: Keep your changes as small and focused as possible. +2. **Include Tests**: If you are introducing a new feature or fixing a bug, write corresponding tests in `tests/`. +3. **Update Documentation**: If your changes alter public behavior or introduce new APIs, update the docs under `web/docs/src/content/docs/`. +4. **Follow Commit Conventions**: Write clear, descriptive commit messages.