Contribution Guide

このリポジトリへのコントリビュートに関するガイドです。

Issues

なんでも歓迎です。例えば以下のようなトピックが考えられます。

Pull Request は master ブランチをターゲットブランチにして 発行してください
作業に関連する Issues が存在する場合は、可能な限り Issues へのリンクを示してください
- Issue 番号 XXX に対する PR である場合、概要欄のどこかに ref: #XXX と書いてあるとわかりやすいです

このガイドでは、Python で書かれたパッケージに対して初めてコミットする方向けに、開発手法のうちのひとつを説明しています。既に何らかの開発手法について理解されている方は、この節を読む必要はありません。

Python 公式ページを参照してください。リンク先のページを見てもよくわからない場合は、お使いの OS をキーワードにして検索すると良いでしょう。(例えば Windows を使用している場合、"Python3 Windows インストール方法" で検索する、など)

git をインストールしたのち、本リポジトリを fork & clone してください。

fork & clone をするには GitHub のアカウントが必要です。必要であればアカウントを作成してください。

fork したあなた (ユーザー名: USER_NAME) のリポジトリの名前が YOUR_REPOSITORY である場合、以下のコマンドで clone することができるはずです。

$ git clone https://github.com/USER_NAME/YOUR_REPOSITORY.git

$ python3 -m venv ./virtualenv
$ source ./virtualenv/bin/activate
(virtualenv) $ # 仮想環境に入った際にはこのように表示されます

setup.py 経由で、仮想環境に statements-manager をインストールする
- 実装したものをデバッグするには、この環境で実行すると良いです。仮想環境を使用する利点は、あなたが普段使用する Python の環境を汚すことなく開発中のプログラムをインストール・実行できることです。

(virtualenv) $ python3 setup.py install

(virtualenv) $ deactivate