部品ライブラリ更新の際の一般規約 - KogakuinRobotProject/DesignSparkPCB-Library GitHub Wiki
勝手に部品ライブラリを更新されると大変面倒なことになります。絶対にやめてください。
以下に部品を更新する場合の一般規約を示します。この手順に従って更新してください
前提条件
- 部品の作成は個人個人でやっていいですが、誤って共用ライブラリには追加しないでください。作る場合はmypartsなどとファイルを作成してつかしてください。
- ライブラリ管理者を立てて、共用ライブラリはその人のみが行うこと。これは、このライブラリに限らず、gitを使う場合の前提知識です。ただし、この場合、masterブランチのことを指します。
手順
- 追加(もしくは変更)してほしいパーツを一つのファイルに格納する。
- ファイルを作成する。ただし、回路図だけ、部品図だけであれど。Components(.cml)は必要。
- 変更であれば、既存のものからコピーしてそれを更新する。
- 動作確認のため、Componentsも同様に行う。
- 新しいブランチを作成(重要)してそれでmasterブランチにpull-requestする。このとき、ブランチ名と同名がいいかもしれない。ただし、同一名のブランチは作成できないので、そこをどうするか?
*このとき、回路図、部品図だけであれば、置換されるのでComponents(.cml)はコミットする必要なし。ただし、管理者が理解できるので一緒にやっても大丈夫かな? - ライブラリ管理者は、更新すべき部品を精査。問題がなければ、当該部品を更新してcommitすること。このとき精査には、問題がないか見つけるとともに、
- 部品の回路図・部品図が既成のものでできないか?(重複すると面倒)
- 部品作成のルールに違反していないかどうか
さらに、単純なマージはできない。 - ローカルに当該ブランチをpull
- master側で--no--ffかつコミットなしでmerge
- 当該部品を更新して、追加されたファイルを除去
- コミットして、push
- 使用している全員にpull勧告すること