Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[Feature] Improve documentation for database types and how they are generated and documented.

オープン
#437 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@dean-krueger がすでに取り組んでいます。

2026年5月18日 から。

評価

この issue はまだ評価されていません。

説明

What is the motivation for your feature request? Please describe what you want to use it for.

The process of adding new compound/complex data types to the database backends, for use by archetype developers, is arcane and poorly documented. The documentation does provide a list of available database types, but little about how to add new ones.

Describe the feature you'd like.

Add a page to the archetype developers guide that descibes:

  1. how to add new data types
  2. the various ways those data types are automatically processed and why

Describe alternatives you've considered.

The alternative is that developers need to do a forensic code study to figure out what's going on (or ask an AI agent to help).

Additional context.

This may be a good task for pair-programming since the complexity of these processes may be understood more easily by multiple people sharing perspectives.

How can this issue be closed?

Add a page to the documentation that covers these topics.

主要言語
Python
スター
8
フォーク
33
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

cyclus/cyclus.github.com のほかの issue

cyclus/cyclus.github.com の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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