CONTRIBUTING.md

Contribution Guide

Roots_homeの編集に協力して頂きありがとうございます。

ざっくりとしたルールをここに記載します。

• PR、issue大歓迎です。
• 下記の手順に従ってローカルテストした後にPRを作成してください
• その他、細かいルールは下記を参照してください

ローカルでテストする

Roots_homeの見栄えをローカルでチェックしてから、GitHubにPushしましょう。

Roots_homeはMkDocsというPythonベースのソフトウェアによって生成されています。 このソフトウェアをローカル環境に構築するのは手間なので、 Dockerを使用して、環境構築を省きます。

Dockerをインストールした環境で、 次のコマンドでRoots_homeをクローンし、webページを生成してブラウザで表示します。

$ git clone https://github.com/SSL-Roots/Roots_home
$ cd Roots_home
$ ./build.sh

...
INFO     -  Documentation built in 1.55 seconds
INFO     -  [13:02:40] Serving on http://127.0.0.1:8000/Roots_home/

コマンドを実行したらブラウザで http://127.0.0.1:8000/ にアクセスしましょう。

Roots_homeを編集する

作成するファイルについて

Markdownファイルを編集するだけでページを作成できます。 HTMLやCSSの知識は不要です。

ブランチについて

masterブランチにPushすると、GitHub Actionsでスクリプトが実行され、 GitHubサーバ上のgh-pagesブランチへマージされます。

実際にWebsiteとして表示されるのはgh-pagesのコンテンツです。