[Docs] Consistently refer to either `codeql-pack.yml` or `qlpack.yml`
- 主要言語
- CodeQL
- スター
- 10.1k
- フォーク
- 2.1k
- 平均マージ
- 2日 15時間
- マージ済み PR(30日)
- 141
説明
**Description of the issue**
Apparently `codeql-pack.yml` and `qlpack.yml` are equivalent:
https://github.com/github/codeql/blob/3674966946b395a9cc03f314b4d361f3c565ec97/docs/codeql/ql-language-reference/ql-language-specification.rst?plain=1#L67
This might be a source of confusion, so it would be good to at least consistently refer to this file only by one name[^1] (except for the specification mentioned above). Here are cases where `codeql-pack.yml` is currently used:
- `github/codeql`
- https://github.com/github/codeql/blob/3674966946b395a9cc03f314b4d361f3c565ec97/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst?plain=1#L71
- ...?
- `github/docs`
- https://github.com/github/docs/blob/5f66400982b48a0f97b4dd2c85bb2677edd09206/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md?plain=1#L75
- ...?
- `github/vscode-codeql`
- https://github.com/github/vscode-codeql/issues/4104
Additionally it might be good to mention in https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs#about-qlpackyml-files that `codeql-pack.yml` is an alias.
What do you think?
[^1]: If the canonical name is `qlpack.yml`, then maybe prefer that, except that the lock file is named `codeql-pack.lock.yml` ...
コントリビューションガイド
調査の方向性
まず、参照されている ql-language-specification.rst と customizing-library-models-for-actions.rst のファイルを確認し、続いてリンク先の GitHub Docs ページと vscode-codeql issue を調べます。どのファイル名を正式なものにすべきかを判断し、指定されたドキュメント全体に他の参照がないか確認します。ドキュメントで一貫して 1 つの名前を使用しつつ、仕様上の例外を維持し、適切な箇所でエイリアスを記載できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- yaml
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100