chirimen-drivers

Language: Japanese, English (Google Translation)

Contributing Guidelines

CHIRIMEN Drivers へのコントリビュート方法です。

行動規範

コントリビューター行動規範 - Contributor Covenant

行動規範に反するコントリビュートは受け入れません。

Issues

質問、バグ、提案、その他 Issue を歓迎します。

Pull Request

ドキュメント追加、モジュール追加、バグ修正、その他改善するための Pull Request を歓迎します。

ファイル構造

/
├── LICENSE
├── CONTRIBUTING.md
├── README.md
├── docs
├── examples
│   └── ...
├── raspi-examples
│   ├── hello-world
│   │   └── ...
│   └── ...
├── node-examples
│   ├── hello-world
│   │   ├── package.json
│   │   └── ...
│   └── ...
├── lerna.json
├── package.json
└── packages
    ├── hello-world
    │   ├── package.json
    │   └── ...
    └── ...
ファイルパス 説明
/CONTRIBUTING.md このドキュメト
/docs/examples サンプルコードの説明のためのドキュメント
/raspi-examples CHIRIMEN for Raspberry Pi ブラウザ用サンプルコード
/microbit-examples CHIRIMEN with micro:bit 用サンプルコード
/node-examples Node.js 用サンプルコード
/packages モジュールのソースコード

修正の送り方

ドキュメントの誤字や文言の変更など軽微な修正は直接 GitHub 上で編集して Pull Request を送ることが可能です。 詳しくはリポジトリのファイルを編集するを参照してください。

あるいは、Git を使って直接ファイルの追加・編集・削除を管理することが可能です。 リポジトリをフォークして Pull Request を送るには、以下のドキュメントを参照してください。

  1. リポジトリをフォークする
  2. プルリクエストの作成方法

推奨するモジュールの構成

ES Modules を推奨します。

例: @chirimen/hello-world

package.json

name は、パッケージを公開する際の名前です。 必ず @chirimen/ から始めてください。

exports は、モジュールのエントリーポイントを指定します。 exports.import は、ES Modules のエントリーポイントを指定します。

scripts は npm コマンドで実行可能な任意のスクリプトです。 詳しい説明は npm-scripts のドキュメントを参照してください。

その他のプロパティの説明は npm-package.json のドキュメントを参照してください。

例:

{
  "name": "@chirimen/hello-world",
  "version": "1.0.0",
  "type": "module",
  "exports": {
    ".": {
      "import": "./index.js"
    }
  },
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/chirimen-oh/chirimen-drivers.git",
    "directory": "packages/hello-world"
  },
  "publishConfig": {
    "access": "public"
  }
}

リリース方法

デフォルトブランチの内容をもとに GitHub Actions によって自動的にリリースされます。

https://www.npmjs.com/package/{パッケージ名} にアクセスして新しいバージョンに更新されていれば成功です。

jsDelivr

npmjs.com に登録されれば自動的に jsDelivr など他の npm と連携している CDN サービスにも自動的にホスティングされるはずです。 具体的には https://www.jsdelivr.com/package/npm/{パッケージ名} が新しいバージョンで更新されていれば成功です。 もし、jsDelivr にホスティングしているファイルが更新されていない場合、https://purge.jsdelivr.net/npm/{パッケージ名} にアクセスしてキャシュを削除することによって新しいバージョンに更新します。