Components of this project
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- jquery, nodejs, react, yaml
- 領域
- documentation, tooling
調査の方向性
提案されているopensgy-schema.ymlから始め、issueのソース形式、入力方法、パーサー、レンダリング対象、ストレッチゴールがどのように組み合わさるかを確認します。どのコンポーネントが対象範囲に含まれ、既存のプロジェクトファイルやツールのどれがそれらに対応しているかを特定します。プロジェクトで合意されたコンポーネントアーキテクチャと、実行可能な実装範囲が定まれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Here are what I see as the necessary components of the Open Styles project.
The Basics
- a source format/structure
- an entry method
- a parser for rendering output into HTML, PDF, Vale YAML, etc
For the source format, I am proposing YAML files that can be concatenated to make up a full listing. This means any tooling must be able to assemble the complete data object out of 1+ files. I hope the advantages of a flat-file database over an RDB are clear, as they enable source/version control and forking. My recommended "schema" is here.
For the entry method, we can obviously just edit YAML files, but we might consider repurposing a web interface like NetlifyCMS or another headless CMS that can be schemed to generate entry forms for YAML objects. That doesn't feel like a core part of the project, but it could be if people find the data format too overwhelming.
Finally, we will need to be able to generate new source files and rendered artifacts alike. My preference here is to go via AsciiDoc for HTML and PDF, so our templates can be used to build both HTML and PDF. We also need to parse rules into Vale or other linter formats. My go-to here is Liquid, which I've had some success teaching. But I also think we just need exemplary tooling, and this is simple enough that folks will create rendering systems through their preferred environments.
Nice-to-haves/Stretch Goals
-
Front-end tools that recognize terms and present popovers, as I've done with my Jekyll theme's glossary. This is done in rudimentary jQuery, but it would be great to make it available under other frameworks or even just clean it up really good.
-
Packaging (and maybe a renderer) that will excite front-end developers, which probably means NodeJS/npm on the back end and something modern like React or Vue on the front end.
What am I missing?
- 主要言語
- 言語のデータがありません
- スター
- 7
- フォーク
- 1
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DocOps/openstyles のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
DocOps/openstyles#1 · コメント 3 件 · リアクション 1 件 ·
DocOps/openstyles の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
UNIVERSE-HPC/course-material#283 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
supadata-ai/mcp#27 ·
-
area:space-accuracy good first issue track:data
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
Sara-Managed-Projects/space-radar#904 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100