Uru:
- Ikike imepụta README, docstring na mgbanwe mgbanwe dabere na ndị na-ege ntị lekwasịrị anya na isi mmalite ya na AI
- Ikike ikewapụ 'ihe/otu' na 'ihe kpatara' n'ígwé n'ime akwụkwọ wee gbakwunye 'ihe kpatara' dịka mmadụ.
- Nyochaa usoro nrụnye site na iji ya onwe ya mee ka akwụkwọ ahụ bụrụ akụkụ nke mgbanwe koodu
Akụkụ ngwanrọ a na-elegharakarị anya mana nke na-adịte aka bụ akwụkwọ. A na-agụ koodu ahụ ọbụlagodi mgbe ọnwa gachara; Onye dere ya apụọla, e chefuola ihe ndị gbara ya gburugburu, naanị ihe e dere na ya ka dị. README dị mma (akwụkwọ mmeghe nke na-akọwa ihe ọrụ bụ na otu esi etinye ya ma na-agba ọsọ), nkọwa koodu nkọwa na akwụkwọ API ọhụrụ (akwụkwọ ntụaka nke na-akọwa otu esi eji interface) na-ekpebi ozugbo ọsọ nke otu. AI na-ewepụ ọtụtụ "ike ọgwụgwụ ide" site na akwụkwọ - mana ọ na-abịa na ọnyà: AI nwere ike ịpụta site na koodu ihe ọ na-eme, mana mgbe mgbe enweghị ike ịma ihe mere o ji mee otú ahụ.
N'ime nkeji a, ị ga-amụta otu esi emepụta README, nkọwa koodu, docstring (nchịkọta nkwupụta edere kwa ọrụ / klas), akwụkwọ API na mgbanwe mgbanwe na AI; na otu esi echekwa akụkụ akwụkwọ kacha baa uru n'ime mmadụ: "ihe kpatara ya."
Ọdịiche dị n'etiti "Gịnị" na "Gịnị kpatara"
Enwere akwụkwọ edemede abụọ. Nke mbụ bụ gịnị/otú: "ọrụ a na-ahazi ndepụta", "gbaa iwu a ka ịwụnye". Enwere ike wepụ ihe ndị a site na koodu na nhazi; AI kacha mma ebe a. Nke abuo, gịnị kpatara: " gịnị kpatara anyị ji mee ka ọrụ a ghara imekọrịta ihe kama ịmekọrịta," " gịnị kpatara uru njedebe a ji dị 30 sekọnd", " gịnị kpatara anyị ji họrọ ọba akwụkwọ a karịa nke ọzọ ". Edeghị ihe ndị a na koodu; Ọ bụ ngwaahịa nke mkpebi imewe, ihe mgbochi, na mgbu gara aga.
AI amaghị "ihe kpatara ya"; Nke kachasị mma, ọ na-eme atụmatụ ezi uche dị na ya-nke dị ize ndụ, n'ihi na ihe na-ezighị ezi dị njọ karịa enweghị ihe kpatara ya. Ya mere, nkewa nke ọrụ doro anya: AI na-edepụta "gịnị/ kedu," ị gbakwunyere "ihe kpatara ya." Okwu kacha baa uru bụ nke na-ekwu ihe koodu enweghị ike ikwu.
NDỤMỌDỤ: Ejighachila ikwughachi ihe koodu ahụ n'onwe ya na-ekwu n'ụzọ doro anya (dị ka i = i + 1 // welie m otu). AI mgbe ụfọdụ na-emepụta okwu ndị dị otú ahụ na-abaghị uru; Wepụ ha ma tinye ume gị n'okwu "ihe kpatara"
Nzọụkwụ site nzọụkwụ: Ọgbọ akwụkwọ na AI
- Kọwaa ndị na-ege ntị lekwasịrị anya. “Onye nrụpụta ka na-amalite,” “otu mpụga nke ga-eji API a,” “m ga-eme n'ọdịnihu” - ndị na-ege ntị na-esetịpụ ụda maka asụsụ na omimi.
- Nye isi iyi. Tinye koodu dabara adaba, README dị adị, ojiji ọmụmaatụ na ngwa ngwa. Akwụkwọ na-enweghị isi bụ ọkpụkpọ òkù imepụta.
- Usoro ntinye. Akụkụ ọkọlọtọ maka README (Ebumnobi, Nwụnye, Ojiji, Nhazi, Ntụnye), usoro ọrụ maka docstring.
- Kaa akara na oghere "ihe kpatara ya". Rịọ AI ka ọ akara mkpebi nke ọ na-amaghị ihe kpatara ya dị ka "ihe mere a chọrọ" ndetu ebe a"; Mgbe ahụ, ị dejupụta oghere ndị ahụ.
- Nyochaa. N'ezie na-agba ọsọ nwụnye nzọụkwụ; nwaa koodu nlele. A README nke na-adịghị arụ ọrụ dị njọ karịa enweghị README ma ọlị.
Obere obere atọ
Ikpe 1 - README gbagoro n'ụgbọ mmiri. README ngwá ọrụ mepere emepe efughị; Ndị ntinye aka ọhụrụ gbalịsiri ike na nwụnye maka nkezi nke awa 2. Ndị otu ahụ nyere AI edemede nrụnye na ngwugwu.json wee depụta README ahaziri, wee mee usoro ahụ n'onwe ha na igwe dị ọcha wee gbakwunye ntụkwasị obi abụọ na-efu efu. Oge nwụnye maka ndị ntinye aka na-esote belatara na nkezi nke nkeji iri abụọ na ise.
Ikpe 2 - Ọnyà emebere "ihe kpatara". Onye nrụpụta jụrụ AI maka ikwu okwu na-esote uru oge akwụsị (oge agwụla = 30). AI dere ezi uche ma na-ezighi ezi "ịnagide nkwụsị netwọk dị elu"; ezigbo ihe kpatara ya bụ oke nkwekọ nke ọrụ mgbada 30 sekọnd. Nkọwahie ahụ mere ka onye nrụpụta na-esote mụbaa uru na-enweghị isi, na-eduga na ihe omume. Ihe nkuzi: onye nwe koodu ahụ ga-enyocha nkwenye ahụ.
Ikpe 3 - Ụkpụrụ Docstring aghọwo akpaaka. Modul inyeaka nwere ọrụ 40 enweghị ihe ọ bụla. E nyere AI usoro ọrụ (ụdị Google) wee mepụta paramita, nloghachi na nkọwapụta maka ọrụ ọ bụla; Onye nrụpụta nyochara ihe ndị a wee dozie ụdị nkwupụta ole na ole ezighi ezi. Ịdekọ ọrụ 40 gbadara ihe dị ka ọkara otu ụbọchị ruo otu awa.
Ndebiri anọ enwere ike iṅomi
Ederede README ahaziri:
Ndị na-ege ntị: {{eg. onye nkwado ọhụrụ}}.Dee ederede README dabere na faịlụ ndị dị n'okpuru. Nkebi: Ebumnuche, atụmatụ, ihe achọrọ, nrụnye, ọrụ, nhazi, nnwale, ntinye aka. Wepụ iwu nrụnye / na-agba ọsọ site na faịlụ n'ezie; KWESỊRỊ. Kanye akara n'ebe ndị ị na-ejighị n'aka na "[VERIFY]". Isi mmalite: {{package.json / scripts / sample code}}
Akwụkwọ ntụaka Docstring/API:
Dee docstring na ọrụ ndị a n'ụdị {{project style: Google/NumPy/JSDoc}}: nchịkọta dị mkpirikpi, paramita (ụdị + pụtara), nloghachi, ewepụrụ atụpụrụ, 1 mkpirisi atụ. Ekwughachila ihe koodu ahụ kwuru CLEARLY. Kanye akara n'ime mkpebi ndị na-achọ "ihe kpatara" dị ka "[Ihe kpatara ọ dị mkpa]", edela ihe ezi uche dị na ya.{{code}}
Wepu oghere maka okwu "ihe kpatara":
Na koodu a, onye nrụpụta na-esote nwere ike ịjụ " gịnị kpatara nke a?" (nọmba anwansi, mkpebi ndị na-adịghị ahụkebe, mgbakasị ahụ). Nye ikwu okwu SKELETON maka onye ọ bụla, mana hapụ ezi uche efu; M ga-ejupụta izi ezi.{{code}}
Nkwupụta Changelog/PR:
Dee {{mbanye mgbanwe / nkọwa PR}} site na diff dị n'okpuru. Ọkpụkpọ: Gịnị gbanwere (n'asụsụ onye ọrụ), Gịnị kpatara ( mbipụta: {{...}}), imebi mgbanwe (ọ bụrụ na ọ bụla), anwalela ya. Hazie teknuzu okwu iji lekwasịrị ndị na-ege ntị anya.{{diff}}
Ngwa ngwa adịghị ike / Ike siri ike
Adịghị ike: "Dee README maka ọrụ a."
siri ike: "Ndị na-ege ntị: onye mmepụta cloning repo a maka oge mbụ. Dabere na ngwugwu agbakwunyere.json, docker-compose.yml na scripts / folder, dee ederede README na Nzube, ihe ndị chọrọ, ntinye, Ọrụ, Nnwale, Ngalaba ntinye aka. Wepụ iwu ndị a na faịlụ ndị a, emela ka ha jide n'aka na ebe ọ bụla ị nọghị.
Ụdị siri ike na-enye ndị na-ege ntị, isi mmalite, nhazi, na iwu "mee ya, kaa ya"; nke mere na akwụkwọ ahụ dabere na faịlụ ndị dị adị na ebe a ga-enyocha ya nke ọma.
Ụdị akwụkwọ
AI na-eme nke ọma
Mmadụ na-agbakwụnye / na-enyocha
Nwụnye README
ndepụta nzọụkwụ
Gbaa usoro wee kwado
Docstring/API
Nhazi, oke, ụdị
Ụdị ziri ezi yana " gịnị kpatara "
Nkọwa koodu
"Ihe ọ na-eme" nchịkọta
"Gịnị kpatara nke a" ziri ezi
Changelog/PR
mbụ draft
Mmetụta na izi ezi
Mkpebi ihe owuwu (ADR)
ọkpụkpụ
Ezi mkpebi na nkwekọrịta
Akwụkwọ chọrọ nlekọta
Akụkụ kacha dị ize ndụ nke akwụkwọ bụ mgbe ọ pụtara eziokwu n'agbanyeghị na ọ bụ ụgha. Mgbe koodu gbanwere na emelitebeghị akwụkwọ ahụ, ọ na-eduhie onye na-agụ ya nke ọma. AI na-eme ka mmelite dị mfe: wepụta ọdịiche wee jụọ "Kedu akụkụ akwụkwọ mgbanwe a na-emetụta?" ị nwere ike ịjụ. Mana ọ bụ usoro a na-eme ka ọ dị ọhụrụ - mee ka mmelite akwụkwọ bụrụ akụkụ nke mgbanwe koodu (ụkpụrụ nnabata PR). AI na-eme ngwa ngwa; Ndị otu na-ewuli ịdọ aka ná ntị.
Akpachara anya: Ebipụtala na-enyochaghị usoro nrụnye na README. Akwụkwọ "ikekwe ọrụ" nwere ike imebi ụbọchị mbụ onye nrụpụta ọhụrụ wee mebie ntụkwasị obi. Gbaa usoro ahụ n'onwe gị na gburugburu ebe dị ọcha.
Mmejọ ndị nkịtị
- Inweta "ihe kpatara" iji dabara AI. Ikwe ezi omume ụgha dị njọ karịa enweghị ezi omume; Onye nwe koodu kwesịrị ide ihe kpatara ya.
- Anaghị enyocha usoro nrụnye. README nke na-adịghị arụ ọrụ na-emebi ntụkwasị obi.
- Okwu na-enweghị isi na-emegharị koodu ahụ. Ọ na-emepụta mkpọtụ, na-ekpuchi nkọwa "ihe kpatara" n'ezie.
- Ọ bụghị ịkọwapụta ndị na-ege ntị lekwasịrị anya. Akwụkwọ na-edoghị anya onye edere ya abaghị uru nye onye novice ma ọ bụ ọkachamara.
- Kewapụ mmelite na usoro. Ọ bụrụ na ejighi koodu emelite akwụkwọ a, ọ na-aghọ aghụghọ ngwa ngwa.
Na nchịkọta
AI na-ewepụ ọtụtụ n'ime ibu ọrụ ahụ site na akwụkwọ: ngwa ngwa README, docstring, API reference, changelog na nkọwa PR. Ma ọ pụghị ịma "ihe kpatara ya", nke bụ oyi akwa kachasị bara uru, ọ dịkwa ize ndụ ime ya. Nkewa nke ọrụ doro anya: AI na-emepụta "gịnị/kedu," ị na-agbakwunye "ihe kpatara ya." Kọwaa ndị na-ege ntị, nye akụrụngwa, wepụta usoro, kaa akara ebe ị ga-adaba, wee nyochaa usoro nrụnye ọ bụla site na iji ya n'onwe gị. Mee akwụkwọ ka ọ bụrụ akụkụ dị mkpa nke mgbanwe koodu.
Ọrụ ngwa
Họrọ modul ma ọ bụ obere oru ngo nke akwụkwọ ya na-efu ma ọ bụ emechiela ya. Buru ụzọ wepụta nkọwapụta sitere na AI yana ndebiri “README a haziri ahazi” (ma ọ bụ docstring); Jide n'aka na ị ga-enye isi iyi na ndị na-ege ntị lekwasịrị anya. Gaa n'isi nke ọ bụla ebe AI nwere akara [VERIFY] ma ọ bụ [Ihe mere achọrọ]: n'ezie na-agba ọsọ nhazi usoro wee jupụta n'ichepụta "ihe kpatara" na ihe ọmụma nke gị. Rịba ama usoro ole kwesịrị idozi yana ole "ihe kpatara" i gbakwunyere.
ndetu
- [] N'ime akwụkwọ ahụ, m na-amata ọdịiche nke "ihe/how" na "ihe kpatara" n'ígwé.
- [] Anaghị m eme AI ka ọ bụrụ "ihe kpatara ya", m na-agbakwunye ya n'onwe m.
- [] M na-enye ndị na-ege ntị ngwa ngwa na faịlụ isi mmalite.
- [] Ana m enyocha isi ihe [VERIFY] nke AI nwere akara site n'ime ya n'onwe ya.
- [] M na-ewepụ okwu ndị na-adịghị mkpa na-emegharị koodu ahụ.
- [] Ana m eme mmelite akwụkwọ ahụ akụkụ nke mgbanwe koodu.