Agent guidance for the DPG repos: one public guide in .github and a complete AGENTS.md in each repo

オープン
  • 何か問題がありますか？
#2,965 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
領域
documentation

調査の方向性

Start with oclapi2’s existing AGENTS.md as the model, then review its core/services/ examples and oclweb3’s src/common/plugins/loader.js extension point. Create the shared guide and fixed text in OpenConceptLab/.github, then prepare complete AGENTS.md and CLAUDE.md files for all nine listed repos. Done means each repo has its own commands, conventions, extension points, PR rules, and the required shared block; oclapi2 also includes the Elasticsearch and isolated compose recipes.

索引モデルが issue の本文から書いたものです。

説明

component/docs decision/planning-needed signal/large-scope signal/low-risk signal/needs-human signal/well-specified stage/triaged type/docs

Coding agents read a repo's own AGENTS.md or CLAUDE.md. They don't read the org's .github repo, so they miss OCL's contribution rules, and those files say little about how OCL code is written. In most DPG repos the AGENTS.md holds only tool boilerplate. As a result, agent-written PRs add procedural modules to class-based code, invent layer names (providers/ where OCL uses services/), and add code that makes a DPG repo depend on something outside the DPG.

This ticket writes that guidance once, publicly, and points every DPG repo to it. It replaces ocl_issues#2709. Related: OpenConceptLab/ocl_online#568.

Acceptance criteria

  • A public guide in OpenConceptLab/.github, next to DIGITAL-PUBLIC-GOOD.md, covering:
    • how DPG code stays complete on its own (DPG rules 2, 4 and 5): the test; what open code may do on its own (record usage and show totals; protect the server based on load or abuse); extension points whose default allows everything; and optional connected-service clients that stay off until configured. Where a case is unclear, ask a maintainer;
    • coding conventions for the Django and React repos: logic goes in classes, following the existing service and model patterns; use the existing layer names (services/, models, serializers, views; in React, services/ and components/); add no new layer or top-level folders; look for an existing class or utility to extend before adding a file;
    • the contribution rules from CONTRIBUTING.md that agents miss: every PR links an issue (closes OpenConceptLab/ocl_issues#N) and carries a type/ label. Reuse the ocl-cli wording from ocl_issues#2709.
  • One short block of fixed text, kept in .github, that every DPG repo's AGENTS.md includes: this repository is part of the OCL DPG, the guide applies, with a link to it.
  • Each DPG repo has an AGENTS.md that is complete on its own: overview, layout, build, test and lint commands, conventions with that repo's real examples, extension points, PR rules, and the fixed block. The repos are oclapi2, oclweb3, oclweb2, oclmap, ocl-cli, ocldev, ocl_omrs, ocl-docs and ocl-design-system. oclapi2's current AGENTS.md is the model.
  • Each repo's CLAUDE.md is just @AGENTS.md. Tool-specific boilerplate that outside contributors can't use (the code-review-graph block) is removed from both files.
  • AGENTS.md ends with: "If an AGENTS.local.md file exists in this repo, read it too. It adds to this file and never relaxes the guide."
  • oclapi2's AGENTS.md adds the search_index --create step for a fresh Elasticsearch, and a recipe for running tests in an isolated compose stack per worktree.
  • One PR per repo. The .github guide merges first.

Code to cite as examples: oclapi2 core/services/; oclweb3 src/common/plugins/loader.js (an extension point with an empty default).

主要言語
言語のデータがありません
スター
4
フォーク
2
平均マージ
2時間 12分
マージ済み PR（30日）
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenConceptLab/ocl_issues のほかの issue

OpenConceptLab/ocl_issues の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。