From 30140f48d0968460fff7ef15994b616ee10e3d3f Mon Sep 17 00:00:00 2001 From: umi <57262844+umi-umi@users.noreply.github.com> Date: Fri, 24 Sep 2021 14:51:34 +0900 Subject: [Docs] update Japanese translation of pr_checklist.md (#13693) * update pr_checklist.md translation * update file based on comments * add id on feature_led_indicators.md and update text based on comments * update file based on comments * update file based on comment --- docs/ja/feature_led_indicators.md | 2 +- docs/ja/pr_checklist.md | 17 ++++++++++++++--- 2 files changed, 15 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/ja/feature_led_indicators.md b/docs/ja/feature_led_indicators.md index 307603f0a4..764b478c31 100644 --- a/docs/ja/feature_led_indicators.md +++ b/docs/ja/feature_led_indicators.md @@ -25,7 +25,7 @@ LED の状態を `uint8_t` として提供する2つの非推奨の関数があ * `uint8_t led_set_kb(uint8_t usb_led)` と `_user(uint8_t usb_led)` * `uint8_t host_keyboard_leds()` -## 設定オプション +## 設定オプション :id=configuration-options インジケータを設定するには、`config.h` で以下の `#define` をします: diff --git a/docs/ja/pr_checklist.md b/docs/ja/pr_checklist.md index 9026ac4866..18dbeccebb 100644 --- a/docs/ja/pr_checklist.md +++ b/docs/ja/pr_checklist.md @@ -1,8 +1,8 @@ # PR チェックリスト これは、提出された PR を QMK の協力者がレビューする際に何をチェックするのかの非網羅的なチェックリストです。 @@ -73,11 +73,13 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - キーボードが QMK で起動するために最低限必要なコードが存在する必要があります - マトリックスと重要なデバイスの初期化コード - (カスタムキーコードや特別なアニメーションなど)商用キーボードの既存の機能をミラーリングする場合は、`default` ではないキーマップを使って処理する必要があります + - Vial 関連のファイルまたは変更は QMK ファームウェアで使用されないため受け入れられません (Vial 固有のコアコードは提出またはマージされていません) - `keyboard.c` - 空の `xxxx_xxxx_kb()` または他の weak-define のデフォルト実装関数が削除されていること - コメントアウトされた関数も削除されていること - `matrix_init_board()` などが `keyboard_pre_init_kb()` に移行されました。[keyboard_pre_init*](https://docs.qmk.fm/#/ja/custom_quantum_functions?id=keyboard_pre_init_-function-documentation) を参照してください - カスタムマトリックスを使用する場合は、`CUSTOM_MATRIX = lite` を選択し、標準のデバウンスを許可します。[マトリックスコードの部分置き換え](https://docs.qmk.fm/#/ja/custom_matrix?id=lite) を参照してください + - 可能な場合は、独自の `led_update_*()` 実装よりも LED インジケータの[設定オプション](https://docs.qmk.fm/#/ja/feature_led_indicators?id=configuration-options)を優先してください。 - `keyboard.h` - 先頭に `#include "quantum.h"` を置きます - `LAYOUT` マクロは、該当する場合は標準の定義を使用してください @@ -95,9 +97,12 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard ...キーマップの `process_record_user()` 内で `layer_on()`、 `update_tri_layer()` を手動で処理する代わりに。 - default (および via) のキーマップは「素朴」でなければなりません。 - 他のユーザーが独自のユーザー固有のキーマップを開発するための「クリーンな状態」として使用するための最低限のもの。 - - これらのキーマップで推奨される標準レイアウト（可能な場合） + - これらのキーマップでは標準のレイアウトが推奨されます（可能な場合） + - デフォルトのキーマップは VIA を有効にするべきではありません -- VIA の統合ドキュメント類には `via` という名前のキーマップが必要です。 - PR の提出者は、同じ PR に機能を紹介する個人的な（または豪華な）キーマップを持たせることができますが、「デフォルト」のキーマップに埋め込むべきではありません - PR の提出者はまた、既存の商用キーボードへ QMK を移植する場合、その商用製品の既存の機能を反映する「製造業者に一致する」キーマップを持つことができます +- PR に VIA の json ファイルを含めないでください。これらは QMK ファームウェアで使われないため QMK リポジトリに属しません -- それらは [VIA のキーボードリポジトリ](https://github.com/the-via/keyboards)に属します。 + さらに、ChibiOS に固有で: - 既存の ChibiOS ボード定義を使用することを**強く**推奨します。 @@ -132,3 +137,9 @@ There are instructions on how to keep your fork updated here: Thanks for contributing! ``` + +## レビュープロセス + +一般的に、PR がマージの対象となる前に、意味のある(例えば、コードを検査した)2つ(またはそれ以上)の承認を確認したいと考えています。これらのレビューはコラボレータに限られません -- 時間を割いてくれるコミュニティメンバーは誰でも歓迎(奨励)されます。唯一の違いは、チェックマークが緑にならないことですが、それは問題ありません。 + +また、PR レビューは自由な時間に行われるものです。それは好意で行われるものなので、私たちはレビューに費やす時間に対して、報酬はうけとっていませんし埋め合わせもありません。そのため、私たちがあなたのプルリクエストに取り掛かるのには時間がかかります。家族や生活のことで PR に手が回らなくなることもあり、そして燃え尽き症候群は深刻な懸念です。QMK ファームウェアリポジトリは、毎月平均200件の PR が開かれ、200件の PR がマージされますので、しばらくお待ちください。 -- cgit v1.2.1 From 4f37084677d7868362809bdd7df44d44efab2b67 Mon Sep 17 00:00:00 2001 From: clickclackwho <57939398+clickclackwho@users.noreply.github.com> Date: Fri, 24 Sep 2021 08:43:05 -0700 Subject: [Docs] Broken FAQ hyperlink (#14578) --- docs/understanding_qmk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index e3dd5cb780..da622044c3 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md @@ -4,7 +4,7 @@ This document attempts to explain how the QMK firmware works from a very high le * [Introduction](getting_started_introduction.md) * [How Keyboards Work](how_keyboards_work.md) -* [FAQ](faq.md) +* [FAQ](faq_general.md) ## Startup -- cgit v1.2.1