life-itself/web3

Rework root README.md now that site is launched

Open

#74 opened on 2022年3月18日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)HTML (1,644 stars) (218 forks)batch import
good first issue

説明

README.md at root of repo is what people currently see arriving here. We should probably revise it given that a) we now have the main site b) it is now the contribute path for devs

Suggest:

  • Move current README content into e.g. notes as awesome-crypto-critique or similar (easiest)
    • Someday we can move all the library items into the library and then build the page off that but until then ... this is KISS
  • Revise README with brief intro to project and instructions for devs and others (and perhaps a pointer to old awesome-cryto-critique content for people who arrive at github repo looking for that - we still have quite a few links on twitter etc to it)

コントリビューターガイド

技術スタック
なし
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
MarkdownUnderstanding of project goals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
The current README.md should be revised to reflect the launch of the main site. Move existing content into a separate file like 'awesome crypto critique.md' for preservation. Then rewrite the root README.md with a brief project introduction, developer contribution instructions, and a pointer to the old content for users arriving via Twitter links. Review the issue comments for any additional context.