リポジトリに関するガイドライン

リポジトリ作成

• emacs-jp organizationには、原則メンテナンスが必要なパッケージのリポジトリのみを作成する
• 新しいパッケージは、emacs-jpでなく個人のスペースに作成する
• MELPA, el-getは同期が面倒になるので、ここに作らず、必要あれば個人のスペースに forkする

メンテナンスするパッケージを決定するまでの流れ

1. emacs-jp.github.comの issuesで提案する
2. メンテナンスする必要があるか、代替できるものがあるかなどについて議論する
3. メンテナンスすると判断した場合、何を行うべきかを議論する
4. 管理者権限を持つユーザにリポジトリを作成してもらう
5. (必要あれば)そのリポジトリのチームを作成する

メンテナンスを行うパッケージの開発の流れ

• 前の議論で出たメンテナンスすべき点のすべてを、リポジトリの issuesに記載する
• アクションを起こす際は必ず issuesを確認する。新規開発以外については issueベースで作業を行う
• コミットログには原則 issue番号を含め, どの問題と関連づいた修正かを明確にする
• 大規模な修正・新規コードの追加、自信のないコミット、意見を求めたい修正については pull requestを行う
• 自明な修正、READMEの修正等については直接 masterに pushすることを許可する

issueの作成

• issueのタイトルは原則英語とする(issueタイトルは他から参照する可能性があるため)
• 議論については場合により日本語も可とする

コミットログ

• issueに関連する修正については必ずそれを示す(#issue番号をつける)
• 原則英語で行う。ただし以下は例外とする
  • 明らかに使用者が日本人に限られる場合(日本語変換の拡張等)

MELPA, el-get登録までの流れ

• 事前の議論で出た issuesをすべて消化する
• テストがあれば、テストが通ることを確認する
• (Emacsは性質上厳密にテストをすることが難しいので)数人に利用してもらい問題がないことを確認する
• READMEがなければ作成する
  • MELPA, el-getのメンテナが読むことを考慮し、概要は英語で書く(日本語併記でも構わない)
• MELPA, el-getに pull requestを行う