Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

want to have CONTRIBUTING.md #114

Open
minheibis opened this issue Aug 18, 2023 · 1 comment
Open

want to have CONTRIBUTING.md #114

minheibis opened this issue Aug 18, 2023 · 1 comment

Comments

@minheibis
Copy link
Contributor

minheibis commented Aug 18, 2023

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

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

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

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

@ryo-ma
Copy link
Collaborator

ryo-ma commented Aug 18, 2023

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants