{ } jq-lite
jq-lite / Docs

Contributing

On this pagePrepare a useful reportBefore proposing a changeProject source and downloads
このページの目次調査しやすい報告を準備する変更を提案する前にソースコードと配布物

調査しやすい報告を準備する

  1. jq-lite -v、perl -vの結果とOSを記録する。
  2. JSON入力とクエリを小さな再現例へ絞る。
  3. 期待する結果、実際の結果、標準エラー、終了コードを記載する。
  4. jqとの互換性の報告なら、jqのバージョンと結果も記録する。
  5. 認証情報や非公開データは再現例から除く。

変更を提案する前に

CLI仕様、Library API仕様、互換性の差分を確認してください。公開動作を変える場合は互換性を慎重に検討します。内部モジュールは実装詳細です。

ソースコードと配布物

ソースコード、Issueの管理、配布物は外部サービスにあります。このサイトのガイドを読むために外部へ移動する必要はありませんが、実際の報告の送信とパッケージ取得には外部サービスを使います。

このサイトから代理でIssueを送信する機能はありません。

Prepare a useful report

  1. Record the output of jq-lite -v and perl -v, and your operating system.
  2. Reduce the JSON input and query to a small reproducible example.
  3. Include the expected output, actual output, stderr and exit code.
  4. For compatibility reports, record the jq version and its output too.
  5. Remove credentials and private data from examples.

Before proposing a change

Read the CLI contract, Library API contract and compatibility inventory. Changes to documented public behavior require careful compatibility review. Internal modules are implementation details.

Project source and downloads

The project source, issue tracker and release distributions are hosted externally. Reading the guides on this website does not require leaving it. Submitting a report or downloading the package uses the project's external services.

This website does not submit issues on your behalf.

All documentationHome