コードフォーマットのための必須オンボーディングトレーニング?

こんにちは。私は https://discourse.bokeh.org を運営しており、https://discuss.python.org にも頻繁にアクセスしています。どちらのサイトでも、新規ユーザーが最初の投稿でコードをフォーマットしないという非常に厄介な問題があります。Python のメインフォーラムでは、通常、1 日に複数件の投稿でユーザーが修正を求められています。[1] これは、多くの人々の時間を膨大かつ継続的に奪っています。

新規ユーザーが最初の投稿を許可される前に、必須のオンボーディングフローを導入することは可能でしょうか?具体的には、ユーザーにコードフォーマットの方法を提示し、その後、フォーマットされたコードを 2〜3 行手動で再現するタスクを与えるフローを考えています。これを正常に完了しないと、投稿が許可されません。


  1. Python ではインデントが重要であるため、これは特に厄介な問題です。 ↩︎

「いいね!」 2

Unformatted Code Detector をご覧になりましたか?これは、他のいくつかのコミュニティで同様の問題に役立ちました。

「いいね!」 3

せいぜい限定的な成功だったと言えるでしょう。少なくとも https://discourse.bokeh.org では。しかし、私の知る限りでは Pythonフォーラムにもインストールされました(私はそこの管理者ではありません)。

「いいね!」 2

そうは思いません。警告が表示されなかった Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org を参照してください。

必須のオンボーディングがあれば、コードを含むスクリーンショットに役立ちますが、OCRを使用して、既存の「フォーマットされていないコード検出器」プラグインのような警告をそのような投稿に表示することもできるでしょう。

Bokehをフォローしていないので、プラグインがうまく機能しているかどうかは判断できません。

「いいね!」 1

実際、unformatted code detector プラグインは discuss.python.org で有効になっています。そのフォーラムの Users カテゴリを確認したところ(最近このカテゴリは見ていませんでしたが)、以前よりずっと良くなっているように見えますが、まだフォーマットされていないコードが含まれる投稿がいくつかあります。

参考までに、今日、プラグインが検出できなかった大きなコードブロックの例を以下に示します(これはしきい値を超えるはずです)。

これは、OPがいくらか気分を害したように見えた、このオンボーディング/コードフォーマットのトピックに関する派生的な議論を促しました。

プラグインは壊れているのでしょうか、それとも更新が必要なのでしょうか?いずれにせよ、投稿を許可される前に、コードをフォーマットする必須のチャレンジは、「自動検出」に加えて価値のあるものだと私はまだ考えています。

「いいね!」 1

デフォルトのパラメータと例のフォーマットされていないコードでテーマコンポーネントを確認しました。
動作しているようです。

リンク先の整形されていない50行以上のコードを防ぐことは全くできていません。この件は、さらに多くの論争に発展しています。:slight_smile:

もう少し強制的にすべきでしょうか? :roll_eyes:
簡単な最初のステップとして、ボタンのテキストを少し変更して、「送信」を「\u003ckbd\u003e注意!!!!\u003c/kbd\u003e」のようなものにするのはどうでしょうか…