auto-commit-system README

これは拡張機能「auto-commit-system」のREADMEです。まず簡単な説明を書き、その後に以下のセクションを含めることをおすすめします。

Features

拡張機能の具体的な機能を説明してください。実際に動作しているスクリーンショットを掲載すると分かりやすくなります。画像パスはREADMEファイルからの相対パスで指定します。

例えば、拡張機能プロジェクト内に images フォルダがある場合：

ヒント: 多くの人気拡張機能ではアニメーションGIFが活用されています。機能を分かりやすく紹介できるためおすすめです。短く、要点が伝わりやすいものが理想的です。。。

Requirements

必要な要件や依存関係がある場合は、このセクションに記載してください。インストール方法や設定方法も併せて説明すると親切です。

Extension Settings

拡張機能が contributes.configuration 拡張ポイントを利用して VS Code の設定項目を追加する場合は、このセクションを記載してください。。

例:

この拡張機能は以下の設定を追加します。

• myExtension.enable: 拡張機能の有効化/無効化
• myExtension.thing: blah に設定すると特定の機能を有効化

Known Issues

既知の問題を記載してください。あらかじめ共有しておくことで、同じ内容のIssueが重複して報告されるのを防げます。

Release Notes

アップデート時の変更内容を記載してください。ユーザーにとって重要な情報になります。

1.0.0

初回リリース

1.0.1

Issue # の修正

1.1.0

機能 X、Y、Z を追加

拡張機能開発ガイドライン

拡張機能を公開する前に、ガイドラインを確認し、ベストプラクティスに従っていることを確認してください。

• Extension Guidelines

Markdownの編集

READMEはVisual Studio Codeで編集できます。便利なショートカットは以下の通りです。

• エディタを分割する (Cmd+\ : macOS、Ctrl+\ : Windows/Linux)
• Markdownプレビューを表示する (Shift+Cmd+V : macOS、Shift+Ctrl+V : Windows/Linux)
• Ctrl+Space を押してMarkdownスニペット一覧を表示する

参考情報

• Visual Studio Code の Markdown サポート

  • http://code.visualstudio.com/docs/languages/markdown

• Markdown 構文リファレンス

  • https://help.github.com/articles/markdown-basics/

お楽しみください！