handshake-org/hsd

Package Level READMEs

オープン

#116 opened on 2019/03/22

 (1 件のコメント) (1 件のリアクション) (0 人の担当者)JavaScript (286 件のフォーク)batch import
Good first issuepkg

Repository metrics

Stars
 (1,814 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

It would be really helpful to have a high level README.md for each package in the lib directory. These could contain a high level overview of the package, including the exports, the classes and their methods, what the package does and any other information that would make understanding the package easier for people. A good example could be found in btcd, where they document each package with a README.md. See this link for an exact example: https://github.com/btcsuite/btcd/tree/master/mempool

Desired information in a lib/{package}/README.md:

  • Classes/functions exported
  • Class methods
  • Minimal amount of configuration to instantiate a Class
  • High level overview of the package itself

Feel free to chime in with any additional thoughts/opinions in what would make these READMEs more useful

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