life-itself/web3

Rework root README.md now that site is launched

Open

#74 opened on Mar 18, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (218 forks)batch import
good first issue

Repository metrics

Stars
 (1,644 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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)

Contributor guide

Research direction
Review the current README.md content, move it to a new file like AWESOME CRYPTO CRITIQUE.md, then rewrite the root README.md with a brief project intro and developer contribution instructions, including a pointer to the old content for users coming from external links.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85