Skip to content

Commit 7be06db

Browse files
hiohiohios-meitoma
andauthored
docs: update CONTRIBUTING.md (#12)
* docs: update CONTRIBUTING.md * docs: reflect review for CONTRIBUTING.md Co-authored-by: s-meitoma <[email protected]> Co-authored-by: s-meitoma <[email protected]>
1 parent 6543653 commit 7be06db

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Guidelines for repository contributors
22

3-
<!-- TODO 当該部分は後ほど修正 -->
43
私たちのプロジェクトへのコントリビュートに関心を示していただきありがとうございます。
54

6-
本レポジトリは、株式投資に関するデータ・環境を提供し、個人投資家の皆様によるデータ利活用の可能性を検証する、(株)日本取引所グループによる期間限定の実証実験プロジェクトの一環で作成しました。
7-
8-
本レポジトリでは、主にSIGNATE社において開催するコンペティションのサポートをスコープとしており、金融分野に馴染みのない方でも、株価や企業業績の推移などの時系列データを解析し、市場の動向やリスクの分析に取り組めるように執筆されています。
5+
本レポジトリは、株式投資に関するデータ・環境を提供し、個人投資家の皆様によるデータ利活用の可能性を検証する、(株)JPX総研によるJ-Quantsプロジェクトの一環で作成しております。
96

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

119
## Our standard
1210

@@ -16,20 +14,22 @@
1614

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

19-
## With issues:
17+
## With issues
18+
2019
我々は、GitHub issuesを参考にコンテンツの改善やバグ修正を行います。
2120

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

25-
## With pull requests:
24+
## With pull requests
25+
2626
本リポジトリに対する加筆・修正等をプルリクエストにて受け付けております。
27-
ブランチは、main(release用), dev, feature(加筆修正用)で管理をしております。
27+
ブランチは、main(release用), feature(加筆修正用)で管理をしております。
2828

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

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

0 commit comments

Comments
 (0)