Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

メンテナー向けのガイドラインを整備する #49

Open
3w36zj6 opened this issue Aug 25, 2024 · 3 comments
Open

メンテナー向けのガイドラインを整備する #49

3w36zj6 opened this issue Aug 25, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@3w36zj6
Copy link
Member

3w36zj6 commented Aug 25, 2024

  • レビューの心得や上流リポジトリの取り込み方法、意思決定の背景などを文章化し、属人化を防ぎたい
@3w36zj6 3w36zj6 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 25, 2024
@kimushun1101
Copy link
Contributor

マークダウンでよいと思うのですが、ファイル名と置き場所はどうしましょうか?
たとえば、https://github.com/php/doc-ja では README_Maintain_HOWTO.md となっています。
現在のリポジトリにREADME.en.md があるので、それに合わせて README.maintainer.md とかではいかがでしょうか?
お作法などあれば教えていただけますと嬉しいです。
これだけ決まっていれば私の方でたたき台を作ってみようと思います。

翻訳者ガイドラインの内容とかぶる部分も多く、将来的には、翻訳提案の手順 2 の内容をメンテナーガイドに少し移してより簡単にした方がよいと思うのですが、いかがでしょうか?
具体例としては、./docs/i18n/**/ の整備はメンテナーがやってしまっても構わないと思っています。実際すでにできているようでした。
翻訳者の参入障壁を少しでも下げたいという狙いです。

### 翻訳提案の手順
1. このGitHubリポジトリをフォークします。
2. ドキュメントの実体は、主にMarkdownおよびYAMLの2種類のファイルから構成されています。それぞれ、下記の注意書きに従って翻訳作業をお願いします。
1. `./docs/i18n/**/`内のYAMLファイル群は、Typstの言語リファレンスの本体です。その中に含まれている、**既存の`*-ja.yaml`ファイルを直接書き換えて翻訳してください****`*-en.yaml``*-zh.yaml`は翻訳しないでください**
- 例:[Reference > Model](https://typst.app/docs/reference/model/)を翻訳する際は、`./docs/i18n/category/model-ja.yaml`を編集してください。`model-en.yaml``model-zh.yaml`は放置してください。
2. `./docs`内のMarkdownファイル群は、Typstのチュートリアルや入門ガイドなど、言語リファレンス以外のページの本体です。**既存のMarkdownファイルを直接書き換えて翻訳してください**
それに加えて、`./docs/src/lib.rs`ファイルの[`urlify`関数](https://github.com/search?q=repo%3Atypst-jp/typst-jp.github.io%20urlify&type=code)を編集して、中国語版の記事タイトルを日本語版のものに書き換えてください。このプロセスを抜かすと、WebページのURLが正しく生成されません。
3. 「サードパーティパッケージ」のページの翻訳を追加する場合は、`./static/assets/index2ja.json`も編集する必要があります。
3. 翻訳の際は、[後述のガイドライン](#スタイルマニュアル)を参照し、[v0.11.1時点での公式ドキュメント](https://github.com/typst/typst/tree/v0.11.1/docs)から翻訳してください。
4. 翻訳作業の途中でも、Draft Pull Requestを作成して、翻訳の進捗状況を共有することができます。
5. 翻訳作業が終わったら、Pull Requestを作成し、送信してください。
ご質問などがある場合は、[「くみはんクラブ」のDiscordサーバー](https://discord.gg/9xF7k4aAuH)に参加してご連絡ください。
もちろん、Discordサーバーに参加していない方からのPull Requestも大いに歓迎します。

@3w36zj6
Copy link
Member Author

3w36zj6 commented Sep 14, 2024

新しくファイルを作成するのではなく、既存のCONTRIBUTING.mdの内容を整理しつつ、新しくメンテナー向けの見出しと内容を追加する想定でした。

@kimushun1101
Copy link
Contributor

kimushun1101 commented Sep 14, 2024

ありがとうございます。なるほど。まずはそれでも良さそうですね。もう少し考えてみます。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants