Ag cur le modúil Weblate

Seachas an príomhstór, tá roinnt modúl Python i Weblate. Leanann siad seo go léir an struchtúr céanna agus clúdaíonn an doiciméadú seo iad go léir.

Mar shampla, clúdaíonn sé seo:

Treoracha códaithe

Ba cheart aon chód le haghaidh Weblate a scríobh agus Prionsabail Slándála trí Dhearadh san áireamh.

Ba cheart go dtiocfadh aon chód le doiciméid a mhíníonn an t-iompar. Ná déan dearmad ar mhodhanna doiciméadaithe, ar bhlocanna casta de chóid nó ar ghnéithe infheicthe an úsáideora.

Ba cheart go n-úsáidfeadh aon chód nua leideanna cineál PEP 484. Níl sé seo á sheiceáil againn inár CI fós toisc nach bhfuil siad san áireamh sa chód atá ann cheana féin.

Ba cheart go leanfadh gealltanais Git Tiomantas Coinbhinsiúin sonraíocht.

Rith tástálacha

Déantar na tástálacha trí úsáid a bhaint as py.test. Ar dtús ní mór duit riachtanais tástála a shuiteáil:

uv pip install -e '.[dev]'

Is féidir leat an tsraith tástála a rith ansin sa taisclann seiceáil amach:

py.test

See also

Tá comhtháthú CI an-chosúil le Weblate testsuite agus comhtháthú leanúnach.

Códú caighdeánach agus linting an cód

Ba cheart go leanfadh an cód treoirlínte códaithe PEP-8 agus ba chóir é a fhormáidiú ag baint úsáide as formáidí cód ruff.

Chun cáilíocht an chóid a sheiceáil, is féidir leat ruff a úsáid, stóráiltear a chumraíocht i pyproject.toml.

Is é an cur chuige is éasca chun é seo go léir a fhorghníomhú ná réamhthiomantas a shuiteáil. Tá cumraíocht sa stór chun a fhíorú go bhfuil na comhaid tiomanta slán. Tar éis é a shuiteáil (tá sé san áireamh sa pyproject.toml cheana féin) cuir ar siúl é trí pre-commit install a rith sa Seiceáil Weblate. Ar an mbealach seo déanfar do chuid athruithe a sheiceáil go huathoibríoch.

Is féidir leat seiceáil a spreagadh de láimh freisin, chun gach comhad a rith a sheiceáil:

pre-commit run --all