mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-12-23 21:23:08 +02:00
Update contribution guide
This commit is contained in:
parent
1fbf20f86b
commit
0730f0299d
2 changed files with 23 additions and 25 deletions
|
@ -1,12 +1,23 @@
|
||||||
Philosophy
|
# :v: Contribution guide :v:
|
||||||
==========
|
Misskeyへの貢献ありがとうございます。
|
||||||
> Keep It Simple, Stupid.
|
|
||||||
|
|
||||||
Translating
|
## Issueの報告
|
||||||
===========
|
新機能の提案や不具合の報告は https://github.com/syuilo/misskey/issues で管理しています。
|
||||||
テキストの出現箇所を`%i18n:id%`という文字列に置換し、対応する値を /locales 下にある言語ファイルに追加します。
|
Issueを作成する前に、既に同じIssueが作成されていないかご確認ください。
|
||||||
|
もし既にIssueが作成されている場合は、既存のIssueにコメントをしたりリアクションをするようお願いします。
|
||||||
|
|
||||||
Tag
|
## 翻訳の改善
|
||||||
===
|
ソースコード中の `%i18n:id%` という形の文字列は、言語ファイルの対応するテキストに置換されます。
|
||||||
[Riot.js](http://riotjs.com)を採用していて、
|
言語ファイルは /locales ディレクトリに存在します。
|
||||||
HTML + Stylus + JavaScript で書きます。
|
|
||||||
|
## ドキュメントの編集
|
||||||
|
現在Misskeyはドキュメントが大きく不足しています。
|
||||||
|
ドキュメントは /docs ディレクトリに存在します。
|
||||||
|
|
||||||
|
## テストの追加
|
||||||
|
現在Misskeyはテストが大きく不足しています。
|
||||||
|
テストコードは /test ディレクトリに存在します。
|
||||||
|
|
||||||
|
## 自動テスト及び自動リリース
|
||||||
|
Travis CIで行っています。
|
||||||
|
設定ファイルは /.travis に存在します。
|
||||||
|
|
17
README.md
17
README.md
|
@ -121,22 +121,9 @@ Debugging :bug:
|
||||||
### Show debug messages
|
### Show debug messages
|
||||||
Misskey uses [debug](https://github.com/visionmedia/debug) and the namespace is `misskey:*`.
|
Misskey uses [debug](https://github.com/visionmedia/debug) and the namespace is `misskey:*`.
|
||||||
|
|
||||||
Contribute
|
Contribution
|
||||||
--------------------------------
|
--------------------------------
|
||||||
Do you have feature request or problem with Misskey?
|
Please see [Contribution guide](./CONTRIBUTING.md).
|
||||||
Please create issue to report it if it is about the Misskey implementation itself.
|
|
||||||
|
|
||||||
Currently Misskey is missing documents so writing documents would be appreciated.
|
|
||||||
Pull requests are always welcome.
|
|
||||||
|
|
||||||
*We love contributions from anybody.*
|
|
||||||
|
|
||||||
Please see also [Contribution guide](./CONTRIBUTING.md).
|
|
||||||
|
|
||||||
### TODO
|
|
||||||
* More [tests](./test)!
|
|
||||||
* More [docs](./docs)!
|
|
||||||
* More sophisticated code!
|
|
||||||
|
|
||||||
Collaborators
|
Collaborators
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
Loading…
Reference in a new issue