Skip to content

chore: bootstrap OpenGym as an LLM-ready repository template - #1

Merged
lev1nson merged 1 commit into
mainfrom
codex/create-repository-template-for-llm
Mar 4, 2026
Merged

lev1nson merged 1 commit into
mainfrom
codex/create-repository-template-for-llm

Conversation

@lev1nson

@lev1nson lev1nson commented Mar 4, 2026 •

Copy link
Copy Markdown
Owner

Motivation

  • Создать базовый, повторно используемый шаблон репозитория для проектов, где основная логика и процессы завязаны на LLM.
  • Дать готовую структуру и рекомендации для быстрой настройки system/user промптов и процесса контроля качества.
  • Предоставить минимальный набор служебных файлов и визуальный баннер для быстрого старта и дальнейшей кастомизации.

Description

  • Добавлен оформленный README.md с баннером assets/opengym-banner.svg и инструкциями по быстрому старту и структуре репозитория.
  • Добавлены ключевые документы: docs/LLM_GUIDE.md, docs/ROADMAP.md, CHANGELOG.md и CONTRIBUTING.md для описания стандартов работы с моделями и плана развития.
  • Созданы шаблоны промптов в prompts/system.md и prompts/task-template.md для фиксации поведения модели и типовых задач.
  • Добавлены файлы репо-гигиены: .gitignore, .editorconfig, LICENSE, и простая GitHub Actions workflow .github/workflows/docs-check.yml для проверки наличия обязательных документов.

Testing

  • Локальная проверка существования обязательных файлов с помощью test -f README.md && test -f docs/LLM_GUIDE.md && test -f prompts/system.md прошла успешно.
  • Набор созданных файлов сверен со списком ожидаемых путей и их содержимое просмотрено на соответствие шаблону.
  • Добавлен минимальный workflow docs-check.yml для автоматической валидации наличия документации, который готов к запуску в CI.

Codex Task

Summary by CodeRabbit

  • Documentation

    • Added comprehensive README with project overview and quick-start guide
    • Added contributor guidelines documentation
    • Added LLM usage guide with standards for models, requests, and evaluation
    • Added project roadmap with phased milestones
    • Added system and task prompt templates
  • Chores

    • Configured editor settings and code formatting standards
    • Added repository ignore patterns for common project types
    • Implemented GitHub Actions workflow for documentation validation
    • Added MIT license and project changelog

@coderabbitai

coderabbitai Bot commented Mar 4, 2026 •

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: 1ad43192-5e89-4809-b21f-7d6df69fbf10

📥 Commits

Reviewing files that changed from the base of the PR and between 621b71f and 1077c41.

⛔ Files ignored due to path filters (1)
  • assets/opengym-banner.svg is excluded by !**/*.svg
📒 Files selected for processing (11)
  • .editorconfig
  • .github/workflows/docs-check.yml
  • .gitignore
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • docs/LLM_GUIDE.md
  • docs/ROADMAP.md
  • prompts/system.md
  • prompts/task-template.md

📝 Walkthrough

Walkthrough

This pull request introduces the foundational template structure for an LLM project named OpenGym. It adds configuration files, a CI workflow for documentation validation, comprehensive documentation including guides and roadmaps, MIT licensing, and reusable prompt templates.

Changes

Cohort / File(s) Summary
Configuration & Tooling
.editorconfig, .gitignore
Editor configuration for consistent formatting (UTF-8, LF line endings, 2-space indentation, trailing whitespace trimming) and ignore patterns for OS, IDE, environment, and language-specific artifacts.
CI/CD Workflow
.github/workflows/docs-check.yml
GitHub Actions workflow that validates the existence of three required documentation files (README.md, docs/LLM_GUIDE.md, prompts/system.md) on pull requests and pushes to main.
Project Documentation
README.md, CONTRIBUTING.md, CHANGELOG.md, docs/LLM_GUIDE.md, docs/ROADMAP.md
Comprehensive documentation suite including project overview and quick-start guide, contributor guidelines in Russian, changelog tracking initial setup, LLM usage standards with quality evaluation criteria, and phased project roadmap from bootstrap through production.
Legal & Licensing
LICENSE
MIT License with copyright notice for 2026 OpenGym contributors.
Prompt Templates
prompts/system.md, prompts/task-template.md
Reusable prompt templates: a system prompt template defining assistant behavior and safety constraints, and a standardized task template with sections for context, task description, input data, constraints, and definition of done.

Poem

🐰 A template takes shape, all tidy and neat,
With docs and workflows, the scaffolding's sweet,
Prompts and guidelines in Russian so fine,
Configuration aligned, each file in line,
OpenGym blooms—let the LLM shine! ✨

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@lev1nson
lev1nson merged commit 031841e into main Mar 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant