OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

should we still reference Perses in showcase notebook?

オープン
#165 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

documentation
主要言語
Jupyter Notebook
スター
70
フォーク
15
平均マージ
10時間 42分
マージ済み PR(30日)
2

説明

When I first ran the showcase notebook without any contextual knowledge, I was confused as to why behavior was described as "Perses-like", since the Perses homepage comes with a big "under development" disclaimer.

I now understand that OpenFE borrowed from Perses, but for a new user I think this is more distracting than it is helpful. I suggest we rephrase or remove these references for the sake of clarity.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ショーケース notebook を開き、動作を「Perses のよう」と説明している参照を見つけてください。周辺の説明を読み、新しいユーザーが Perses の開発状況に気を取られないよう、それらの参照を修正または削除してください。完了条件は、このような文脈上の混乱がなく、notebook の文言が明確になっていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
jupyter-notebook
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。