F-RevoCRMへのコントリビュート方法についてガイドです。
次のIssueを受け付けています。
- 不具合報告(Bug report) => こちらからバグ報告できます
- 要望(Feature request) => こちらから提案できます
- 質問(How to use question) => こちらから質問できます
Pull Requestはいつでも歓迎です。
受け入れるPull Request
次の種類のPull Requestを受け付けています。 基本的なPull Request(特に細かいもの)は、Issueを立てずにPull Requestを送ってもらって問題ありません。
「このような修正/改善はどうでしょう?」という疑問がある場合は、Issueを立てて相談してください。
- 不具合修正
- 機能追加
- 誤字の修正
- 翻訳の追加
受け入れていないPull Request
- CODE OF CONDUCTに反する内容を含むもの
コミットメッセージは以下の形式にしてください。
#{issue num} {コミットメッセージ}
例: 「 fixed #12 ○○の日本語翻訳を修正 」
参考:js-primer/CONTRIBUTING.md at master · asciidwango/js-primer
本レポジトリは現状日本語話者が開発を行うケースが多い為、以下のような規則でコミットメッセージやコメントの記入をお願いします。
モジュール名は基本的に日本語で記入してください。
例)Potentials → 案件
docker → Docker
javascript → JavaScript
のように、一般的な名称はなるべくその正式名称に合わせるようにお願いします。
以下の文言に合わせて利用してください。
Viewの名前 | 名称 | 備考 |
---|---|---|
List | 一覧画面 | |
Detail | 詳細画面・概要画面 | 使い分けをお願いします |
QuickCreate | クイッククリエイト | 右上の+ボタンからレコード作成できる画面全般です |
EditView | 作成画面・編集画面 | |
クイック編集 | 詳細画面や一覧画面で利用可能な、編集画面を経由せずに変更する機能を指します | |
RelatedList | 関連リスト | 例えば顧客企業モジュール内の、顧客担当者一覧などは、関連リストとなります |
CustomView | リスト | 一覧画面の左側に出る、検索条件を保存することが可能な機能です |
Header | ヘッダーメニュー | 上部に表示されるモジュール一覧やレポートへのリンクがあるエリアを指します |
Sidebar | サイドメニュー | |
Settings | システム設定 |