Ag scríobh paiste maith

Scríobh athruithe ar leithligh

Is crá croí é nuair a fhaigheann tú paiste ollmhór a deirtear a shocraíonn 11 fhadhb corr, ach nach n-aontaíonn plé agus tuairimí le 10 gcinn acu nó go raibh 9 gcinn acu socraithe ar bhealach difriúil cheana féin. Ansin, caithfidh an duine atá ag cumasc an t-athrú seo an paiste suimiúil amháin a bhaint as áit éigin laistigh den charn ollmhór foinsí, agus cruthaíonn sé sin go leor oibre breise.

Más fearr, ba chóir go mbeadh gach socrú a réitíonn fadhb ina phaiste/thiomantas féin lena thuairisc/theachtaireacht thiomnaithe féin ina luaitear go díreach cad a cheartaítear ionas gur féidir leis an gcothaitheoir nó le páirtithe leasmhara eile na hathruithe go léir a chur i bhfeidhm go roghnach.

Ina theannta sin, cuireann athruithe ar leithligh ar chumas an roinneadh ina dhá leath i bhfad níos fearr chun fadhbanna agus aischéimniú a rianú amach anseo.

Cáipéisíocht

Is féidir le doiciméadú a bheith ina thasc leadránach; áfach, is gá do dhuine éigin é a chríochnú. Déanann sé rudaí i bhfad níos éasca má chuireann tú an doiciméadú isteach in éineacht le hathruithe cóid. Cuimhnigh le do thoil modhanna, bloic chóid chasta, nó gnéithe atá le feiceáil ag an úsáideoir a dhoiciméadú.

See also

Cur le doiciméadú Weblate

Cásanna tástála

Ligeann na tástálacha dúinn a fhíorú go tapa go bhfuil na gnéithe ag obair mar is ceart dóibh. Chun an cás seo a choinneáil agus a fheabhsú, ní mór gach gné agus feidhm nua a chuirtear leis a thástáil sa tsraith tástála. Ba chóir go mbeadh cás tástála bailí amháin ar a laghad ag gach gné a chuirtear leis a fhíoraíonn go n-oibríonn sí mar atá doiciméadaithe.

See also

Weblate testsuite agus comhtháthú leanúnach

Tiomantas teachtaireachtaí

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

Seiceáil cineáil

Ba chóir d'aon chód nua leideanna cineáil PEP 484 a úsáid. Táimid ag úsáid mypy chun iad a sheiceáil mar go bhfuil breiseán Django ann a fhágann go bhfuil seiceáil cineáil ar aipeanna Django praiticiúil.

Níor cheart go dtabharfadh cód nua agus athraithe teipeanna nua mypy isteach i gcás ina ndéanann tacaíocht reatha clóscríofa Django é sin praiticiúil. Níl an bunchód clúdaithe go hiomlán ag anótálacha cineáil fós, agus tá sé deacair roinnt coincheapa Django a anótáil go beacht. Dá bhrí sin, ní fhorfheidhmíonn CI mypy ach amháin do mhodúil roghnaithe agus tuairiscíonn sé torthaí eile ar leithligh.

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

Ba chóir don chód treoirlínte códaithe PEP 8 a leanúint agus ba chóir é a fhormáidiú ag baint úsáide as formáideoir cóid 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 fusa chun seo go léir a fhorfheidhmiú ná prek a shuiteáil. Is athchur i bhfeidhm tríú páirtí é seo den uirlis pre-commit a úsáideann Weblate. Tá sé san áireamh sna spleáchais forbartha atá dearbhaithe i pyproject.toml, mar sin nuair a shuiteálann tú na spleáchais sin, beidh prek ar fáil.

Chun gach comhad a sheiceáil de láimh, rith:

uv run prek run --all-files

Más fearr leat an cliant bunaidh pre-commit, úsáideann sé an chumraíocht chéanna ó .pre-commit-config.yaml.

Códú slán

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

Treoirlínte na hintleachta saorga

Agus ábhar á chur leis an tionscadal, tugann tú cead dúinn é a úsáid mar atá, agus ní mór duit a chinntiú go bhfuil cead agat é a dháileadh chugainn. Trí athrú a chur isteach chugainn, aontaíonn tú gur féidir leis an tionscadal na hathruithe a ghlacadh agus gur cheart iad a athdháileadh faoin gceadúnas tionscadail. Ba chóir d’údair a bheith ar an eolas go soiléir gurb orthu féin atá an dualgas a chinntiú nach gcuirtear aon chód neamhcheadúnaithe isteach sa tionscadal.

Tá sé seo neamhspleách ar cibé an n-úsáidtear AI nó nach n-úsáidtear.

Agus iarratas tarraingthe á chur isteach agat, ba cheart duit a chinntiú i gcónaí, ar ndóigh, go bhfuil an togra d’ardchaighdeán agus gurb é an iarracht is fearr a dhéantar ná ár dtreoirlínte a leanúint. Riail bhunúsach ordóige is ea má fheiceann duine gur rinneadh an ranníocaíocht le cabhair ó intleacht shaorga, go bhfuil níos mó oibre le déanamh agat.

Is féidir linn cód atá scríofa le cabhair ó shaorga a ghlacadh isteach sa tionscadal, ach ní mór don chód cloí le caighdeáin chódaithe fós, a bheith scríofa go soiléir, a bheith doiciméadaithe, cásanna tástála a bheith ann, agus cloí leis na ceanglais ghnáthúla go léir atá againn.