CONTRIBUTING.md

How to contribute to japanese-address-parser

japanese-address-parserに興味を持っていただきありがとうございます。 このライブラリは@YuukiToriyamaによる個人プロジェクトですが、皆さんのコントリビューションを歓迎します！ 以下ではコントリビューションの手順について説明いたします。

地名の表記ゆれを発見した場合

地名の表記ゆれを発見した場合はIssueで報告していただけると助かります。 市区町村名の表記ゆれと町名の表記ゆれでそれぞれIssueフォームを用意しているので適当なものを選んでください。 なる早で返信いたします。 ご自身で解決できそうな場合は、IssueのAssigneesにご自身を指定していただき、PRを投げてもらっても構いません。

クラッシュを報告する場合

ライブラリがクラッシュした場合は、汎用Issueテンプレートから報告をお願いします。 使用しているRustのバージョン、ライブラリのバージョン、クラッシュログなどを添付していただけると対応可能です。

PRの作成方法

前提知識

このリポジトリでは簡素化したGit-flow方式でのブランチ管理を行なっています。具体的には以下のようになっています。

• mainブランチが全ての親ブランチ
• 何か修正を行なう場合はmainブランチからfeature/*ブランチを切る
• リリースを行なう場合はmainブランチからrelease/vX.Y.Zブランチを切る
  • リリースに含めたいfeatureブランチをrelease/vX.Y.Zにマージする
  • タグvX.Y.Zを打つ
  • リリースが完了したらmainブランチにマージする

何か修正を行ないたい場合はmainブランチから修正ブランチを切ってくださいますようお願いします。 また、PRを作成する際は、とりあえずmainブランチに対して投げてください。こちらで対応するfeatureブランチを作成し、マージ先をそちらに変更いたします。

具体的な作成方法

1. リポジトリをフォークする
2. mainブランチが最新になっていることを確認する
3. mainブランチからfeatureブランチを切り開発を行なう
4. フォーク元のリポジトリのmainブランチに対してPullRequestを発行する