Skip to content

Add README (#3)#4

Merged
not522 merged 6 commits into
not522:masterfrom
KATO-Hiro:document/readme
Sep 14, 2020
Merged

Add README (#3)#4
not522 merged 6 commits into
not522:masterfrom
KATO-Hiro:document/readme

Conversation

@KATO-Hiro

@KATO-Hiro KATO-Hiro commented Sep 11, 2020

Copy link
Copy Markdown
Contributor

レビューをお願いできますでしょうか?

WHAT

  • リポジトリに英語・日本語のREADMEを追加しました。
  • 一部の項目で空欄の情報があります。Questionsの項目をご確認いただければ、と思います。

WHY

  • ライブラリの整備状況、他言語への移植状況などについて、記載する必要があると判断したため。

Questions

以下の項目について、空欄の状態です。
候補を列挙しましたが、どのようなツールを利用する予定でしょうか?

  • テストフレームワーク

    • Pytest, unittest, nose, ...

  • CIツール

    • GitHub Actions, Circle CI, Travis CI, ...

  • 開発環境（任意の項目）

    • Visual Studio Code, Docker, ...

  • 連絡先

    • Twitter, slack, ...

@not522

not522 commented Sep 12, 2020

Copy link
Copy Markdown
Owner

今のところ以下を想定してます。

  • テストフレームワーク

pytest

  • CIツール

GitHub Actions

  • Lint

とりあえずflake8とpep8-namingは入れました。mypyとblackも入れようと思っています。isortはちょっと癖があるので後回しにします。

  • 開発環境（任意の項目）

これは各自好きなものを使えば良いと思います。

  • 連絡先

情報が散逸すると良くないので基本的にはissueでやりとりしましょう。

not522
not522 reviewed Sep 12, 2020
View reviewed changes
Comment thread README.ja.md Outdated
Comment thread README.ja.md
@KATO-Hiro

KATO-Hiro commented Sep 12, 2020

Copy link
Copy Markdown
Contributor Author

今のところ以下を想定してます。

  • テストフレームワーク

pytest

  • CIツール

GitHub Actions

  • Lint

とりあえずflake8とpep8-namingは入れました。mypyとblackも入れようと思っています。isortはちょっと癖があるので後回しにします。

  • 開発環境（任意の項目）

これは各自好きなものを使えば良いと思います。

  • 連絡先

情報が散逸すると良くないので基本的にはissueでやりとりしましょう。

ご丁寧にレビューいただき、ありがとうございます。

テストフレームワーク、CIツール、Lintについては、上記の項目を反映させたいと思います。

開発環境（任意の項目）・連絡先については、記載の必要性が薄いと解釈しました。READMEから削除するという理解でよろしいでしょうか?

@not522

not522 commented Sep 12, 2020

Copy link
Copy Markdown
Owner

はい、開発環境と連絡先は削除しましょう。

@KATO-Hiro

KATO-Hiro commented Sep 12, 2020

Copy link
Copy Markdown
Contributor Author

承知しました。

@KATO-Hiro KATO-Hiro changed the title [WIP] Add README (#3) Add README (#3) Sep 12, 2020
@KATO-Hiro

KATO-Hiro commented Sep 12, 2020

Copy link
Copy Markdown
Contributor Author

ご指摘をいただいた4項目について加筆・修正しました。

WHAT

進捗状況

  • アルゴリズムの説明を公式ドキュメントのリンクに変更しました。

使い方

  • 「依存関係にあるライブラリを一つのファイルにまとめる機能を提供する予定である」ことを追記しました。

利用環境・開発環境

  • テストフレームワーク、CIツール、Lintのツール名とリンクを追記しました。
  • 開発環境（任意の項目）・連絡先の項目を削除しました。

@not522

not522 commented Sep 13, 2020

Copy link
Copy Markdown
Owner

README.ja.mdはREADME_ja.mdに変更してください。

not522
not522 reviewed Sep 13, 2020
View reviewed changes
Comment thread README.ja.md Outdated
Comment on lines +73 to +82
ターミナルに以下のコマンドを貼り付けてください(注: $マークは、コマンドを実行する際には不要です)。

```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)を作成し、全てのテストが通ることを確認してください。

@not522 not522 Sep 13, 2020

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

もうちょっと詳しく書こうかと思うので、とりあえず準備中としてください。

@KATO-Hiro KATO-Hiro Sep 13, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

承知いたしました。

@KATO-Hiro

KATO-Hiro commented Sep 13, 2020

Copy link
Copy Markdown
Contributor Author

README.ja.mdはREADME_ja.mdに変更してください。

変更しました。

また、レポジトリに貢献する方法の記述を「準備中」にしました。

ご確認をお願いできますでしょうか?

not522
not522 reviewed Sep 13, 2020
View reviewed changes
Comment thread README.md Outdated
@not522

not522 commented Sep 14, 2020

Copy link
Copy Markdown
Owner

ありがとうございます。マージします！

@not522 not522 merged commit 9c5085b into not522:master Sep 14, 2020
@KATO-Hiro

KATO-Hiro commented Sep 14, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

ありがとうございます。

とても貴重な経験をさせていただき、感謝しております。

@not522 not522 mentioned this pull request Sep 19, 2020
Closed
@KATO-Hiro KATO-Hiro deleted the document/readme branch October 18, 2020 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@not522 not522 not522 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KATO-Hiro @not522