OSS Gate Workshop: online: 2023-09-30: odentakashi Todo-Tree: Work log #1671
Comments
|
vscodeの拡張機能から探してみる |
|
Todo-Treeというvscodeの拡張機能を試してみる |
|
ライセンスは MIT License とのこと https://github.com/Gruntfuggly/todo-tree/blob/master/License.txt |
|
https://opensource.org/licenses/ |
|
GitHubのリポジトリ: https://github.com/Gruntfuggly/todo-tree |
|
|
|
環境: macOS |
|
インストール手順はこれでよさそうですね https://github.com/Gruntfuggly/todo-tree/blob/master/README.md#installing |
|
vscode上で
|
|
問題なくインストールできた |
|
使い方を探しているが見当たらない |
|
うーんそうみえますね。 |
|
このわからなさの背景には一般的なTODOの認識とここで使われているソースコードに直接TODOを書くというTODOへの認識の違いがあるのかもしれない |
|
そもそもTODOの説明が足らないかもしれない |
|
ここで使われているTODOの説明: https://www.jetbrains.com/help/idea/using-todo.html |
|
Piroさんからアドバイスいただいた Readmeの前提条件（文脈？）として 参照リンク先 |
|
修正方法: 外部サイトにリンクを貼るか、Readmeに文章を書くか -> 一長一短
Github内のドキュメントを参照するならパーマリンクを貼ればいいんだけど アメリカだとフェアユース - Wikipediaという基準がある |
OdenTakashi
changed the title
|
初めて使おうとした場合に使い方がわからないと困るので報告したい。 |
|
報告方法に指定はなさそう |
|
使い方がわからないという問題なので |
|
報告テンプレートも特になし。 |
|
伝えたいこと
|
|
READMEの修正に関しては、具体的に改善があるならば「ここをこういうふうに直すといいと思います。」のように具体案を提示するのが良い。 READMEの修正は上記のものが期待値を含んでいるので別途期待値を書く必要はない |
|
タイトル:"How about adding an explanation about TODO in the README?" 本文: But It took me some time to understand how to use it. Because I didn't know the culture of embedding comments like TODO or FIX in source code. So, if possible, explaining such a culture might make it more understandable. |
- This extension quickly searches (using [ripgrep](https://github.com/BurntSushi/ripgrep)) your workspace for comment tags like TODO and FIXME, and displays them in a tree view in the activity bar.
+ This extension quickly searches (using [ripgrep](https://github.com/BurntSushi/ripgrep)) your workspace for comment tags like TODO and FIXME, and displays them in a tree view in the activity bar.hogehoge
|
|
|
アノテーションコード（コマンド？）は、わかりやすい表記にしてもいいかもです！ |
|
Thank you for great extension ! But It took me some time to understand how to use it. Because I didn't know the culture of embedding comments like TODO or FIX in source code. So, explaining such a culture might make it more understandable. How about adding links to explanations about the culture regarding TODO or FIXME as follows? README.md
- This extension quickly searches (using [ripgrep](https://github.com/BurntSushi/ripgrep)) your workspace for comment tags like TODO and FIXME, and displays them in a tree view in the activity bar. The view can be dragged out of the activity bar into the explorer pane (or anywhere else you would prefer it to be).
+ This extension quickly searches (using [ripgrep](https://github.com/BurntSushi/ripgrep)) your workspace for comment tags like [TODO](https://www.jetbrains.com/help/idea/using-todo.html) and [FIXME](https://www.jetbrains.com/help/idea/using-todo.html) and displays them in a tree view in the activity bar. The view can be dragged out of the activity bar into the explorer pane (or anywhere else you would prefer it to be).
|
|
リンクを追加する提案にしてみました。 |
|
|
|
リンク切れのある可能性があるためwikiなどのリンク切れがないであろうリンクを使うようにする。 |
|
おつかれさまでした！ ワークショップの終了にともないissueを閉じますが、このまま作業メモとして使っても構いません 👌 ワークショップの感想を集めています！ ブログなどに書かれた際は、このページへリンクの追加をお願いします 🙏 またの参加をお待ちしています！ |
|
@OdenTakashi こちらその後いかがでしょうか〜？ |
|
@komagata 今週末を目処に作業を行う予定です。 その際に文章のサポートを依頼させていただくかもしれませんが、その際はどうぞよろしくお願いします🙇♂️。 |
|
@komagata |
|
@OdenTakashi PR作成おめでとうございます〜！ |
|
@OdenTakashi こちら、メインのコントリビューターにメンションで、「こちらいかがでしょうか〜」的なメッセージ送ってもいいかもですね。大分日にちが経っているので。 |
|
@komagata |
|
@OdenTakashi スバラシィ〜 |
This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.
作業ログ作成時の説明
以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。
タイトル例↓：
OSS Gateワークショップ関連情報
The text was updated successfully, but these errors were encountered: