Add an XML ecosystem profile (XSD, RELAX NG, Schematron, XSLT)

オープン
#86 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
53/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python, xml
領域
testing, tooling

調査の方向性

Read the existing profile modules, tests/test_go.py, tests/support.py, and tests/test_ecosystem_contract.py to learn the registration and fixture conventions. Add project_validator/ecosystems/xml.py, register it in BUILT_IN, and add the XML fixture layout and profile tests. Done means the configured fixture passes applicable checks, the bare fixture passes none, snapshots are recorded, and the README “Applies to” column is updated.

索引モデルが issue の本文から書いたものです。

説明

Profile

Recognised by intent (#63): *.xsd, *.rng / *.rnc, *.sch, *.xsl / *.xslt, *.xspec. Supplies the schema practices from #85.

Practice Rule for this ecosystem
schema-declared XSDs declare a targetNamespace and elementFormDefault; instance documents name their schema (xsi:schemaLocation / xsi:noNamespaceSchemaLocation, or an <?xml-model?> processing instruction)
schema-validation CI runs xmllint --noout --schema / --relaxng, jing, or a Schematron processor (SchXslt)
schema-examples XSpec suites (*.xspec) for XSLT and Schematron, run in CI; for XSD / RELAX NG, valid and invalid example documents
tests-run XSpec runs in CI (xspec.sh, the XSpec Maven or Ant targets)
code-formatting xmllint --format checked in CI, or prettier with @prettier/plugin-xml

Notes

data-wellformed (#84) covers well-formedness. External DTDs and entities must never be fetched.

Definition of done

  • One profile module, project_validator/ecosystems/xml.py, registered in BUILT_IN. Nothing in project_validator/checks/ changes: a row marked later belongs to a check that does not exist yet and is recorded on that check's issue.
  • tests/fixtures/well_configured_xml passes every check that applies to it, and tests/fixtures/bare_xml passes none of the ecosystem's practices (tests/test_ecosystem_contract.py). Snapshots recorded with UPDATE_SNAPSHOTS=1.
  • A project layout in tests/support.py, profile tests like tests/test_go.py, and the README "Applies to" column (tests/test_documentation.py).
  • A practice with no good evidence for this ecosystem is left out (the check reports SKIP) rather than judged by weak evidence.
主要言語
Python
スター
4
フォーク
1
平均マージ
10時間 41分
マージ済み PR(30日)
79

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

cpp-best-practices/project_validator のほかの issue

cpp-best-practices/project_validator の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。