HSP-Knowledgeへようこそ！ このサイトでは、HSP (Hot Soup Processor) に関する知識やTipsを誰でも共有できます。

📝 記事投稿の概要

HSP-Knowledgeへの投稿は GitHub を介して行われますが、専門的な知識は必須ではありません。 以下の2つの方法があります。

  1. 【推奨】投稿支援ツールを使う: サイト上のエディタで記事を書き、GitHubへ連携する方法。
  2. 【上級者向】GitHub/ローカルで直接作成: 自分でMarkdownファイルを作成し、Pull Requestを送る方法。

方法1: 【推奨】投稿支援ツールを使う

GitHub上でいきなりファイルを作成すると、「ファイル名の形式ミス」や「設定ヘッダ（Front Matter）の記述ミス」、操作ミスによる「空ファイルの作成」などが発生しやすく、自動システムによるチェックでエラーになりがちです。

本サイトでは、これらのミスを自動で防ぐための投稿支援ツール（WYSIWYGエディタ） を用意しています。

手順

  1. サイト右上の 📝 記事を投稿する ボタンをクリックします。
  2. 「新規記事を作成」 を選択し、エディタ画面を開きます。
  3. タイトル、著者名、タグ、記事本文を入力します。
    • ※ プレビューを見ながらWord感覚で執筆できます。
  4. 「💾 GitHubで保存」 ボタンを押します。
    • 記事データがクリップボードにコピーされ、GitHubの新規作成画面が開きます。
  5. GitHubの画面で、本文エリアに 貼り付け (Ctrl+V) します。
    • ファイル名や設定ヘッダが自動的に正しい形式で入力されます。
  6. 「Commit changes…」 ボタンを押し、「Create a new branch…」 を選んで 「Propose changes」 をクリックします。
  7. 「Create pull request」 ボタンを押して投稿完了です！

方法2: 【上級者向】GitHubで直接作成・編集する

Gitに慣れている方や、GitHubのWeb UI上で直接編集したい方は、手動でファイルを作成することも可能です。 ただし、以下のルールを厳守してください。形式が間違っていると、自動レビューで却下されます。

⚠️ 手動作成時のよくあるミス（弊害）

GitHub上で適当にファイルを作ると、以下の理由でマージできないケースが多発しています。

  • ❌ ファイル名の間違い: 日付が入っていない、日本語を使っている、拡張子がない。
  • ❌ Front Matterの不備: 記事先頭の --- で囲まれた設定部分がない、またはYAML形式が不正。
  • ❌ テンプレートの消し忘れ: 「ここに本文を書きます」などの文字が残ったままになっている。
  • ❌ 空ファイルの作成: 操作ミスにより、中身が空のファイルが作成されてしまう事故。

✅ 重要なルール：1 PR 1 記事

原則として、1つのPull Requestには1つの記事のみを含めるようにしてください。

複数の記事をまとめて1つのPRで送ると、以下の問題が発生します。

  • 自動レビューシステムが正しく判定できない場合があります。
  • 1つの記事に不備があると、他の正しい記事も巻き添えでマージできなくなります。
  • 空ファイルなどのゴミファイルが混入した際に気づきにくくなります。

正しいファイル作成ルール

  1. ファイル名: 必ず YYYY-MM-DD-英数字タイトル.md の形式にしてください。
    • 例: 2025-12-07-hsp-tips.md
  2. Front Matter: ファイルの先頭には必ず以下のメタデータを記述してください。
---
layout: post
title: 記事のタイトル
date: 2025-12-07 12:00:00 +0900
author: あなたの名前
tags: [HSP3, Tips]
summary: 記事の概要（一覧表示用）
---

テンプレートの利用

手動作成する場合は、必ずテンプレート _posts/template.md の内容をコピーして使用することをお勧めします。

🤖 自動レビューと公開までの流れ

Pull Request (PR) を作成すると、AI (Gemini Code Assist) と 検証システム が自動的に記事をチェックします。

1. 自動チェックの実行

PR作成後、すぐに以下のチェックが行われます。

  • ファイル名や形式が正しいか？
  • HSPに関連する内容か？
  • スパムや不適切な内容が含まれていないか？
  • 他人の記事を勝手に書き換えていないか？（編集権限チェック）

2. 結果の確認

PRのタイムライン（Conversationタブ）に、検証結果がコメントされます。

  • ✅ 承認可能: 問題ありません。公開できる状態です。
  • ⚠️ 形式エラー: ファイル名や記述にミスがあります。修正してください。
  • ❌ スパム判定: 内容が不適切と判断されました。

3. 公開 (/publish)

検証に合格（✅）した場合、あなた（PR作成者）自身の手で記事を公開できます。 PRのコメント欄に以下のコマンドを入力してください。

/publish

システムが自動的に記事を承認(Approve)し、マージしてサイトに公開します。 （管理者の承認を待つ必要はありません！）

💡 記事を書くコツ・仕様

シンタックスハイライト

HSPのコードは ```hsp で囲むと色付きで表示されます。

```hsp
#include "hsp3utf.as"
mes "Hello, HSP!"
```

画像の追加

画像ファイルはGitHubのPR作成画面やエディタ画面にドラッグ＆ドロップすることでアップロードできます。発行されたURLをMarkdown内に貼り付けてください。 （投稿支援ツール上では画像アップロードはできません。GitHub画面に移ってから追加してください）

記事の修正（更新）

公開済みの記事を修正する場合も、同様にPRを作成してください。 注意: date フィールドを変更するとURLが変わってしまいます。更新日時を記録したい場合は date はそのままで、lastupdate フィールドを追加・更新してください。

⚖️ ライセンスについて

本サイトに投稿された記事は、以下のライセンス方針で公開されます。投稿をもってこれに同意したものとみなされます。

  • コードブロック・スニペット: CC0 1.0 Universal (パブリックドメイン)
    • ユーザーは商用・非商用を問わず、クレジット表記なしで自由にコードを利用・改変できます。
  • 記事本文: CC BY 4.0 (クリエイティブ・コモンズ 表示 4.0)
    • 記事を転載・引用する場合は、元の記事へのリンクや著者の表示が必要です。

あなたの知見が、他のHSPユーザーの助けになります。 些細なTipsでも構いませんので、ぜひ気軽に投稿してみてください！ 🎉