Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.72 KB
Raw

Contributing to OpenCharacterBook

Thanks for your interest in contributing to OpenCharacterBook.

Scope of This Repository

This repository is a curated open-source release of an experimental project focused on:

  • readable architecture for AI storytelling systems
  • a working demo of structured LLM generation pipelines
  • useful patterns for the community to learn from and build upon

Before You Start

  1. Read README.md for project status and setup instructions.
  2. Check open issues to avoid duplicate work.
  3. Prefer small, focused pull requests.

Development Flow

  1. Fork the repo and create a branch from main.
  2. Make your change in the relevant area (backend/, frontend/, or docs).
  3. Run the applicable local checks for the area you touched.
  4. Open a pull request with:
    • what changed
    • why it changed
    • how you tested it

Pull Request Guidelines

  • Keep PRs narrow and reviewable.
  • Update docs when behavior changes.
  • Do not include generated artifacts (node_modules, __pycache__, local builds, local env files).
  • Keep public-safe boundaries intact (no secrets, no private endpoints, no proprietary assets).

Commit Style

Use clear, intention-first commit messages. Examples:

  • docs(readme): clarify local dev setup steps
  • backend(generation): add retry logic to pipeline executor
  • frontend(characters): improve character card layout
  • backend(tests): add seed resolver edge case coverage

Reporting Bugs

When filing a bug, include:

  • environment details (OS, Python/Node version)
  • reproduction steps
  • expected vs actual behavior
  • logs or screenshots if relevant

Security Issues

Please do not open public issues for sensitive vulnerabilities. Follow SECURITY.md.