diff options
| author | Aya Morisawa <AyaMorisawa4869@gmail.com> | 2017-03-26 21:32:19 +0900 |
|---|---|---|
| committer | Aya Morisawa <AyaMorisawa4869@gmail.com> | 2017-03-26 21:34:14 +0900 |
| commit | 0730f0299dbdc6704d34951c1cc0dfbb2d5dee55 (patch) | |
| tree | f3d81298f918b4ba17b11766d0316902e18ede13 /CONTRIBUTING.md | |
| parent | Extract devDependencies (diff) | |
| download | sharkey-0730f0299dbdc6704d34951c1cc0dfbb2d5dee55.tar.gz sharkey-0730f0299dbdc6704d34951c1cc0dfbb2d5dee55.tar.bz2 sharkey-0730f0299dbdc6704d34951c1cc0dfbb2d5dee55.zip | |
Update contribution guide
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1827daeb04..e7515260f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,23 @@ -Philosophy -========== -> Keep It Simple, Stupid. +# :v: Contribution guide :v: +Misskeyへの貢献ありがとうございます。 -Translating -=========== -テキストの出現箇所を`%i18n:id%`という文字列に置換し、対応する値を /locales 下にある言語ファイルに追加します。 +## Issueの報告 +新機能の提案や不具合の報告は https://github.com/syuilo/misskey/issues で管理しています。 +Issueを作成する前に、既に同じIssueが作成されていないかご確認ください。 +もし既にIssueが作成されている場合は、既存のIssueにコメントをしたりリアクションをするようお願いします。 -Tag -=== -[Riot.js](http://riotjs.com)を採用していて、 -HTML + Stylus + JavaScript で書きます。 +## 翻訳の改善 +ソースコード中の `%i18n:id%` という形の文字列は、言語ファイルの対応するテキストに置換されます。 +言語ファイルは /locales ディレクトリに存在します。 + +## ドキュメントの編集 +現在Misskeyはドキュメントが大きく不足しています。 +ドキュメントは /docs ディレクトリに存在します。 + +## テストの追加 +現在Misskeyはテストが大きく不足しています。 +テストコードは /test ディレクトリに存在します。 + +## 自動テスト及び自動リリース +Travis CIで行っています。 +設定ファイルは /.travis に存在します。 |