Contributing to Spindle

Spindleは、Amebaで利用するデザインシステムです。このリポジトリは、デザインシステムで定義された内容を実際に利用しやすいように実装に落とし込んだものです。

Amebaとして提供される成果物は、それらに則って開発されることを推奨しています。そのため、機能の要望や修正のPull RequestはAmebaに在籍するメンバーからのみとしています(ごめんなさい🙇)。

ただし、リンク先のミス、誤字・脱字などのPull Request、Issue提起は大歓迎です。わかりづらい点や疑問に思う箇所がありましたら、お気軽にお知らせください！

Pull Requestの作り方

openameba/spindleをCloneもしくはForkします
作業ブランチを作成し、変更内容を反映します
コミットメッセージはConventional Commits 1.0.0に準拠します
- コミットタイプを適切に設定します
- スコープはspindle-iconsやspindle-uiなど該当するパッケージ名があれば付与します
- 破壊的変更がある場合は、BREAKING CHANGEを明記します
Pull Requestを作成します

作業が終わったらコミットをまとめて、該当ブランチをmainブランチにマージします
- コミットはCHANGELOGに反映されるため、適切な単位でまとめてください
- コミット名についてはPull Requestの作り方欄を参考にしてください
(省略化) リリースされる内容はmainブランチを選択し、npx lerna diffもしくはnpx lerna changedで確認できます。依存モジュールの更新等で対象でないパッケージのバージョンも更新されることがありますが、内容が間違えでなければ問題ありません
変更内容に合わせてリリースブランチを作成します。選択できる名前はrelease.ymlを参照してください
ブランチがプッシュされるとCHANGELOG作成・npmパブリッシュ・Pull Request作成が自動的に行われます
4で作成されたPull Requestの内容を確認し、mainブランチにマージします
開発メンバーに周知します