Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

text-lintに関する記事 first commit #1673

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

shohei-yamashit
Copy link
Contributor

よろしくお願いします

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for peaceful-bassi-80a807 ready!

Name Link
🔨 Latest commit 909fd60
🔍 Latest deploy log https://app.netlify.com/sites/peaceful-bassi-80a807/deploys/67926163c1b22900081e107b
😎 Deploy Preview https://deploy-preview-1673--peaceful-bassi-80a807.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mameka
Copy link
Contributor

mameka bot commented Jan 23, 2025

フィードバックとガイドライン


フィードバック

対象の記事「【補足記事】textlint-filter-rule-allowlistをkernelから使ってみよう」は、以下の点で優れています:

  1. 技術的な深さ:

    • textlintのKernelレベルでの制御方法を具体的なコード例とともに解説しており、読者が実際に試せる内容になっています。
    • 特にfilterRulesの設定やallowlistの活用例が明確で、実務での応用がしやすいです。
  2. 構造の明確さ:

    • 背景、課題、実装例、まとめといった構成がしっかりしており、読みやすいです。
  3. 参考情報の充実:

    • サンプルリポジトリや関連ドキュメントへのリンクが適切に配置されており、読者がさらに深掘りできるよう配慮されています。

改善点:

  • 文章の簡潔さ:
    • 一部の説明がやや冗長に感じられる箇所があります。特に「Kernelによる制御」セクションでは、コード例の前後の説明を簡潔にするとさらに読みやすくなるでしょう。
  • 視覚的な補助:
    • 記事内に図やフローチャートを追加することで、Kernelの動作フローが視覚的に理解しやすくなると思います。

ガイドライン

以下は、PR作成者向けの具体的なガイドラインです:

  1. Netlifyプレビューの確認:

    • コメント内にNetlifyプレビューURLが記載されている場合、リンクをクリックして記事の内容を確認してください。
    • レイアウトや画像が正しく表示されているかをチェックしましょう。
  2. 豆香のレビューについて:

    • 自動生成されたコメントやフィードバックは参考情報として活用してください。一部の指摘が不正確な場合もあるため、内容を必ずご自身で確認してください。
  3. 画像生成の取り扱い:

    • 記事のヘッダーにimage: trueを設定することで、画像生成が有効になります。
    • 画像を再生成したい場合は、コメント欄で@mameka /imageと入力してください。スタイル指定も可能です。
    • 画像が不要な場合は特にアクションは不要です。
  4. 豆香とのやり取り:

    • コメント欄で@mamekaに続けて質問や要望を入力することで、豆香に直接問い合わせが可能です(/image以外のコマンドも対応)。
  5. レビュー依頼の最終ステップ:

    • 全ての確認が完了したら、SlackチャンネルにPRのURLを投稿してレビューを依頼してください。

以上の内容を参考に、PRの完成度を高めてください!

Copy link
Contributor

@mameka mameka bot left a comment

Choose a reason for hiding this comment

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

ヘッダーの日付について

記事のヘッダーに記載されている日付が 2025-01-27 となっています。本日は 2025-01-23 なので、未来の日付として問題ありません。ただし、公開予定日が1週間以上先の場合は意図的かどうか確認をお願いします!

Copy link
Contributor

@mameka mameka bot left a comment

Choose a reason for hiding this comment

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

タイトルの最適化について

現在のタイトルは「【補足記事】textlint-filter-rule-allowlistをkernelから使ってみよう」となっています。このタイトルは内容を的確に表していますが、以下のようなバリエーションも検討してみてはいかがでしょうか?

  • 「textlintのallowlistルールをKernelで活用する方法」
  • 「Kernelからtextlintを使いこなす:allowlistルールの実践」

あくまで提案なので、最終的な判断はお任せします!

Copy link
Contributor

@mameka mameka bot left a comment

Choose a reason for hiding this comment

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

ファイル名の確認

ファイル名が 0127_textlint-tuning-allowlist.md となっていますが、ヘッダーの日付 2025-01-27 に基づいて正しい形式です!素晴らしいです!

@mameka
Copy link
Contributor

mameka bot commented Jan 23, 2025

@shohei-yamashit
記事の内容から以下の画像が生成されました。

この画像を記事に添付する場合は、マークダウンヘッダ部にimage: trueを追加してください。

---
title: タイトル
author: your-name
date: 202X-XX-XX
# 以下を追加
image: true
---

画像の利用は任意です。記事の内容に合っていない場合や画像を添付したくない場合は対応不要です。

画像を再度生成する場合は、このPRのコメントに以下の内容で投稿してください。

# 再生成のみ
@mameka /image
# スタイルを変えて再生成。<style>に画像スタイルを指定
@mameka /image <style>

@kondoumh kondoumh self-requested a review January 23, 2025 12:40
Copy link
Member

@kondoumh kondoumh left a comment

Choose a reason for hiding this comment

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

レビューしました。

src/posts/blogs/2025/0127_textlint-tuning-allowlist.md Outdated Show resolved Hide resolved
src/posts/blogs/2025/0127_textlint-tuning-allowlist.md Outdated Show resolved Hide resolved
};
}
```
textlint-filter-rule-allowlistはあくまでJSのスクリプトなので、型情報はありません。
Copy link
Member

Choose a reason for hiding this comment

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

JSがJavaScriptの略なので「JSのスクリプト」は少し冗長な気がしました。

Publicな文章で拡張子以外でJSと略さない方がいいような気がします(好みの問題な気もするので対応しなくてもいいです)。

- 参照記事のリンクを追加
- moduleInterop の説明を「kernelによる制御」の章に追加
- JS→JavaScript
- コードの変数の前後に"```"を追加
- 文中のKernel→kernel
- その他冗長な表現の修正

#1673 (comment)

#1673 (comment)

#1673 (comment)
Copy link
Member

@kondoumh kondoumh left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants