c-3lab / dim

📦 dim: Manage the open data in your project like a package manager.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

want to have CONTRIBUTING.md

minheibis opened this issue · comments

開発に参加しやすくしてもらうために、 CONTRIBUTING.mdがあるとよいのではないかと思っています。

特に、以下などが課題なのでははないかと思っております。(私も良く分かってない部分もありますが、プルリクを通すにあたり以下のようなところで躓いた or 通ってないプルリクを見るとこのあたりが課題ではないか、という内容です。)

  • deno / typescript に慣れる
    • javascript に慣れる
    • typescript に慣れる
    • deno に慣れる
  • test を書く / 通す
    • テスト一般に慣れる(mock/stub/spy etc)
    • deno のテストに慣れる
    • dim でのテストに慣れる
    • テストを書く
    • テストを通す
  • formatter / linter を通す。
    • 事前に、.github/workflows/test.ymlに書いてあるコマンドを通せばいいだけではあるのですが、ここで引っかかってるプルリクもありそうなので、説明があったほうが良いかもしれないと思っています。

作ってから改善すればいいのと思うので、とりあえずたたき台になりそうなバージョンを作ってみようと思います。

commented

@minheibis いいですね。
少なからず以下のような項目は入れていきたいですね。

  • 技術スタック(参考となる公式ドキュメントなども含めて)
  • ディレクトリ解説
  • ビルド方法(リンクでも良い)
  • PRを出す前に必要なこと
    • formatter, linter
    • test, coverage
  • Github Action
    • CI/CD