Language: Japanese, English (Google Translation)
CHIRIMEN Drivers へのコントリビュート方法です。
コントリビューター行動規範 - Contributor Covenant
行動規範に反するコントリビュートは受け入れません。
質問、バグ、提案、その他 Issue を歓迎します。
ドキュメント追加、モジュール追加、バグ修正、その他改善するための 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 を送るには、以下のドキュメントを参照してください。
ES Modules または UMD (Universal Module Definition) パターンを推奨します。 ES Modules 作成し、Rollupなどを用いて、UMD のフォーマットに変換すると良いでしょう。
name は、パッケージを公開する際の名前です。
必ず @chirimen/ から始めてください。
moduleは Rollup や Webpack で ES Modules を扱うためのフィールドです。必要に応じて ES Modules 形式のスクリプトのファイル名を記載しましょう。
scripts は npm コマンドで実行可能な任意のスクリプトです。
詳しい説明は npm-scripts のドキュメントを参照してください。
その他のプロパティの説明は npm-package.json のドキュメントを参照してください。
例:
{
"name": "@chirimen/hello",
"version": "1.0.0",
"main": "index.js",
"module": "index.esm.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/chirimen-oh/chirimen-drivers.git",
"directory": "packages/hello"
},
"publishConfig": {
"access": "public"
},
"scripts": {
"build": "rollup -c --bundleConfigAsCjs",
"prepublishOnly": "npm run build"
},
"devDependencies": {
"rollup": "~1"
}
}
デフォルトブランチの内容をもとに GitHub Actions によって自動的にリリースされます。
https://www.npmjs.com/package/{パッケージ名} にアクセスして新しいバージョンに更新されていれば成功です。
npmjs.com に登録されれば自動的に jsDelivr など他の npm と連携している CDN サービスにも自動的にホスティングされるはずです。
具体的には https://www.jsdelivr.com/package/npm/{パッケージ名} が新しいバージョンで更新されていれば成功です。
もし、jsDelivr にホスティングしているファイルが更新されていない場合、https://purge.jsdelivr.net/npm/{パッケージ名} にアクセスしてキャシュを削除することによって新しいバージョンに更新します。