DOCS: Create standard for format and structure of top-level project files across AboutCode repos
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- markdown
調査の方向性
まず、dejacode、purldb、scancode.io、scancode-toolkit、vulnerablecode にある、一覧に挙げられたトップレベルのファイルを比較します。この issue では、直ちに対応する対象として、dejacode と scancode.io の RELEASE.md を rST に変換すること、apache-2.0.LICENSE ファイルを LICENSE に名前変更すること、新しい AboutCode リポジトリ向けの標準を文書化することが示されています。ファイル名／形式の規約が適用されるか、明確に文書化されれば完了ですが、この issue は古く、複数のリポジトリにまたがっています。
索引モデルが issue の本文から書いたものです。
説明
In most AboutCode repos we have a set of top-level project files including:
- AUTHORS.rst
- CHANGELOG.rst
- CODE_OF_CONDUCT.rst
- CONTRIBUTING.rst
- LICENSE
- NOTICE
- README.rst
- RELEASE.md (dejacode and scancode.io)
- ROADMAP.rst
I looked at dejacode, purldb, scancode.io. scancode-toolkit and vulnerablecode as the primary examples
Although the GitHub norm is for the these files to be in markdown format we are using rST in most cases so the cost/effort to move to markdown does not make sense at this time.
For the LICENSE and NOTICE files we have a mixed bag:
- dejacode: LICENSE file but no NOTICE (makes sense for AGPL-3.0 vs Apache-2.0)
- purldb: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
- scancode.io: LICENSE and NOTICE files - this should be the pattern for all projects licensed under Apache-2.0)
- scancode-tookit: NOTICE file plus apache-2.0.LICENSE and cc-by-4.0.LICENSE
- vulnerablecode: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
If you have a top-level file named LICENSE GitHub displays the license name in a "tab" at the top of the README. Using LICENSE as the file suffix does not seem to mean anything to GitHub.
The issue here is to standardize the format and structure of these files across repos and document it for new projects/repos. Some immediate action items include:
- Convert RELEASE.md files to rST for dejacode and scancode.io (this should be easy since these are small chunks of text)
- Rename apache-2.0.LICENSE files to LICENSE.
- 主要言語
- JavaScript
- スター
- 9
- フォーク
- 17
- 平均マージ
- 7時間 55分
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aboutcode-org/www.aboutcode.org のほかの issue
-
Making all post button.対応中かも @sarthaklole が 71 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
aboutcode-org/www.aboutcode.org#117 · コメント 3 件 ·
-
WWW: Reduce frequency of update-releases再び着手できるかも @johnmhoran が 52 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンci-workflow
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
aboutcode-org/www.aboutcode.org#180 · 担当者 1 名 ·
-
DOCS: Create new AboutCode stack diagram(s)再び着手できるかも @hixvikas が 53 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンdocumentation
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
aboutcode-org/www.aboutcode.org#166 · コメント 1 件 ·
-
WWW: Create About top level page?対応中かも @pombredanne が 155 日前に担当しました。 オープンwebsite
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
aboutcode-org/www.aboutcode.org#164 · リアクション 1 件 · 担当者 1 名 ·
-
WWW: Add Initiatives and grant Projects再び着手できるかも @mjherzog が 241 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンenhancement needs design website
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
aboutcode-org/www.aboutcode.org#141 · 担当者 1 名 ·
aboutcode-org/www.aboutcode.org の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
tech-debt
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
srikanth235/centraid#1155 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
microsoft/monaco-editor#5563 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信