Add README (#3) #4
Conversation
|
今のところ以下を想定してます。
pytest
GitHub Actions
とりあえずflake8とpep8-namingは入れました。mypyとblackも入れようと思っています。isortはちょっと癖があるので後回しにします。
これは各自好きなものを使えば良いと思います。
情報が散逸すると良くないので基本的にはissueでやりとりしましょう。 |
ご丁寧にレビューいただき、ありがとうございます。 テストフレームワーク、CIツール、Lintについては、上記の項目を反映させたいと思います。 開発環境（任意の項目）・連絡先については、記載の必要性が薄いと解釈しました。READMEから削除するという理解でよろしいでしょうか? |
|
はい、開発環境と連絡先は削除しましょう。 |
|
承知しました。 |
|
ご指摘をいただいた4項目について加筆・修正しました。 WHAT進捗状況
使い方
利用環境・開発環境
|
|
|
README.ja.md
Outdated
| ターミナルに以下のコマンドを貼り付けてください(注: $マークは、コマンドを実行する際には不要です)。 | ||
|
|
||
| ```md | ||
| $ mkdir your_dir_name | ||
| $ cd your_dir_name | ||
| $ git clone git@github.com:not522/ac-library-python.git | ||
| ``` | ||
|
|
||
| 1. 作業を始める前に、Issueを立てるか、Pull Request(PR)の草案を用意するといいと思います。 | ||
| 2. Pull Request(PR)を作成し、全てのテストが通ることを確認してください。 |
There was a problem hiding this comment.
もうちょっと詳しく書こうかと思うので、とりあえず準備中としてください。
変更しました。 また、レポジトリに貢献する方法の記述を「準備中」にしました。 ご確認をお願いできますでしょうか? |
|
ありがとうございます。マージします！ |
|
ありがとうございます。 とても貴重な経験をさせていただき、感謝しております。 |
レビューをお願いできますでしょうか?
WHAT
WHY
Questions
以下の項目について、空欄の状態です。
候補を列挙しましたが、どのようなツールを利用する予定でしょうか?
テストフレームワーク
CIツール
開発環境（任意の項目）
連絡先