Skip to content

want to have CONTRIBUTING.md #114

Description

@minheibis

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

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

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

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions