Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 2.79 KB

Guidelines for repository contributors

私たちのプロジェクトへのコントリビュートに関心を示していただきありがとうございます。

本レポジトリは、株式投資に関するデータ・環境を提供し、個人投資家の皆様によるデータ利活用の可能性を検証する、(株)JPX総研によるJ-Quantsプロジェクトの一環で作成しております。

本レポジトリでは、主にJ-Quants APIのサポートをスコープとしており、金融分野に馴染みのない方でも、株価や企業業績の推移などの時系列データを解析し、市場の動向やリスクの分析に取り組めるようにJ-Quants APIを扱いやすくするPythonパッケージを作成しています。

Our standard

本プロジェクトに関して、問題の報告、建設的な批評、ドキュメントの更新、プルリクエストの要求やパッチの提供、その他の活動を通じて貢献してくれる方に深く感謝いたします。

このプロジェクトに参加する全ての人に対してのハラスメントを禁止します。また、個人攻撃、煽り、公的私的な嫌がらせ、侮辱、その他コントリビュータとして恥ずべき行動を禁止します。

我々は、行動規範に従っていないissue、プルリクエスト等に対して、削除、編集、拒否の権利と責任があります。

With issues

我々は、GitHub issuesを参考にコンテンツの改善やバグ修正を行います。

本リポジトリに関するご要望は、issuesにご質問・ご意見をいただけますと幸いです。 (なお、投稿の際には過去に同じ要望がないかご確認ください。)

With pull requests

本リポジトリに対する加筆・修正等をプルリクエストにて受け付けております。 ブランチは、main(release用), feature(加筆修正用)で管理をしております。

なお、プルリクエストを出していただく際には、以下の観点にご注意ください。

  • 幅広いユーザー層に利用されることを想定してください。
  • プルリクエストを起票いただける場合は、加筆・修正内容をfeatureブランチを適宜作成いただき、mainブランチ に対してプルリクエストを行ってください。
  • 基本的には二つ以上のコミットに分けず、コミットをまとめて行ってください。
  • 外部データを使う場合は、著作権等の権利上問題ないことをreadmeで記載してください。
  • 文献等を参考にした場合は、下記を参考に参考元を必ず明記してください。(被引用箇所を「 」で囲い、引用元のタイトルとURLを(タイトル,URL)記載する。)