Imikhuba emihle yokwakha iSoftware yamahhala nevulekile: Imibhalo

Imibhalo: Izindlela ezinhle zokwenza iSoftware yamahhala nevulekile

Imibhalo: Izindlela ezinhle zokwenza iSoftware yamahhala nevulekile

La imibhalo kuyinto futhi kufanele ibe yingxenye eyisisekelo ye- inqubo yokudala nokuhlela yayo yonke imisebenzi yabantu, nokuningi emkhakheni wezobuchwepheshe, ikakhulukazi endaweni ye Ukuthuthukiswa kweSoftware.

El inhloso yawo wonke amadokhumenti kufanele kube nguYe fundisa abantu besithathu (abasebenzisi, abaphathi, abalondolozi, noma abanye onjiniyela), abangajwayelene ne umkhiqizo (ikhodi, uhlelo lokusebenza noma uhlelo), idalwa kanjani ukwakheka kwayo, ukusebenza kwayo futhi noma kungenzeka, isizathu sokudalwa kwayo nendlela yaso yokuklama nokusebenza.

Imikhuba emihle: Imibhalo - Isingeniso

Ngaphezu kwalokho, esimweni esithile se- Imibhalo yeSoftware yamahhala ibalulekile, ngoba ivumela ukuqinisekisa ngokuphelele i- ukudluliswa kolwazi nokunikezwa amandla kuyadingeka ukuze kufezeke okwenelisayo kwe- 4 inkululeko iphakanyiswe yiyo, okuyi:

  • 0: Inkululeko yokuqhuba uhlelo njengoba ufisa, nganoma iyiphi injongo.
  • 1: Inkululeko yokungena nokutadisha uhlelo, futhi ulushintshe noma ulushintshe ukuze kuzuze wena.
  • 2: Inkululeko yokwabelana noma yokusabalalisa kabusha amakhophi ukusabalalisa okufanayo kanye / noma ukusiza abanye.
  • 3: Inkululeko yokusabalalisa amakhophi wezinguqulo zakho eziguquliwe kubantu besithathu.

Imibhalo emihle yenza kube lula ukuthi umkhiqizo owenziwe:

  • Isetshenziswa kahle, futhi ifundiswa kalula futhi ifundwe kalula.
  • Iqondwe kahle yilabo abafisa ukuyiguqula ukuze bayithuthukise noma bayivumelanise nayo.
  • Yabelwana futhi wamukelwe ngokuzethemba okukhulu, phakathi kwabo bonke obajwayele nabantu ongabazi.
  • Yiba nesisindo esingcono phakathi komphakathi.

Imikhuba emihle: Imibhalo - Readme

Imikhuba emihle: Imibhalo

Okubalulekile

Endabeni Ukuthuthukiswa Kwesoftware Emahhala Nomthombo Ovulekile, ngokuvamile, abasebenzisi abakhulu bemibhalo okuhlobene nokwakhiwa komkhiqizo, yilawo akhona noma azoba khona, i- obhekele ukugcinwa ofanayo. Futhi ngaphandle kwemibhalo emihle noma engekho, okuwukuphela kwendlela esebenzayo ukuyihlola ngqo, ukufeza qonda ukwakheka nokusebenza kwawo.

Ayenzi imibhalo emihle uma kukhulunywa nge thuthukisa iSoftware yamahhala, Umthombo Ovulekile noma olunye uhlobo lwesoftware, ukuthumela kubemukeli bayo (abasebenzisi, abaphathi, abalondolozi, noma abanye onjiniyela) ukuthola indlela ehlathini ngaphandle kwemephu noma ikhampasi.

Dala imibhalo emihle ngayinye Isoftware yamahhala, Umthombo Ovulekile kuyasiza futhi, ngoba, noma kunjalo ukubhala kunezindlekoUkutshalwa kwemali, uma kwenziwa kahle, kuwufanele. Ngoba, umhlaba we Software igcwele izindaba mayelana amakhodi wefa lwezinhlelo ezindala noma zamanje, izinhlelo zokusebenza noma izinhlelo, abantu abambalwa kuphela abanesibindi sokuthinta, ngoba cishe akekho oqondayo. Abahleli bagxila ekwakheni ikhodi futhi bangayibhali kahle nangokufanele. Futhi lokhu kufanele kulungiswe.

Imikhuba emihle emibhalweni kumafayili wombhalo we-README

Endabeni Isoftware yamahhala nomthombo ovulekile, imibhalo ivame ukukhawulelwa kumafayili wombhalo, lapho idalwa ngabantu noma ngamaqembu amancane wohlelo noma imiphakathi. Kepha, ngisho nokwakha imibhalo elula usebenzisa elula ifayela lombhalo README.md (noma .txt) ungaba neyakho imikhuba emihle noma emihle, amathiphu noma umhlahlandlela owusizo wendalo wokulethela abantu besithathu imininingwane ephelele futhi enemininingwane edingekayo mayelana nalokho okudaliwe.

Esihlokweni sethu, sithathe ifayela le- Imikhuba emihle ikhulelwe futhi yadalulwa yi "Code for Development Initiative" i-del Ibhange leNtuthuko yaseMelika, okuthi ngendlela efingqiwe isitshele ukuthi imibhalo emihle isuselwa ku ifayela lombhalo README.md (noma .txt) Kumele ihlelwe kanjena:

Isakhiwo sefayela se-README esinconyiwe

  • Incazelo nomongo: Isigaba lapho kufanele uchaze khona ukusebenza, umongo lapho yathuthukiswa khona nezinkinga zentuthuko ezisize ekuxazululeni.
  • Umhlahlandlela womsebenzisi: Isigaba lapho kufanele kukhulunywe khona kumsebenzisi wokugcina ngokuthi ungaqala kanjani ukusebenzisa ithuluzi ledijithali.
  • Umhlahlandlela wokufaka: Isigaba lapho imiyalo yokufaka yokusebenzisa kabusha nokulungisa ithuluzi ledijithali kufanele ishiwo. Lesi sigaba senzelwe onjiniyela.
  • Abalobi Isigaba lapho amakhredithi kufanele anikezwe abahlanganyeli bethuluzi.
  • Ilayisense yekhodi yamathuluzi: Isigaba lapho izimvume ezinikezwe abantu besithathu ukuthi basebenzise kabusha ithuluzi ledijithali kumele zicaciswe.
  • Ilayisense yemibhalo yethuluzi: Isigaba lapho uhlobo lwelayisense oluqukethwe kumadokhumende adaliwe kufanele kushiwo.

Kulezi imikhuba emihle, bancoma nokuthi bengezwe kufayela le- FUNDA imibhalo yefayela ukwenza iphelele ngokwengeziwe, izigaba ezilandelayo:

  • Unganikela kanjani: Isigaba esichazela onjiniyela abasha inqubo yokunikela kumaphrojekthi.
  • Indlela yokuziphatha: Isigaba esichaza indlela yokuziphatha sisungula izinkambiso zomphakathi, imithetho kanye nezibopho abantu nezinhlangano okufanele bazilandele lapho bexhumana nganoma iyiphi indlela nethuluzi ledijithali noma umphakathi wabo.
  • Amabheji: Isigaba esibonisa amabheji (izithombe ezincane ezishumekwe ku-README.md) ezicacisa ngendlela efundekayo futhi emfushane isimo sethuluzi.
  • Inguqulo: Isigaba esibonisa uhlu lwezinguqulo zethuluzi ledijithali nokusebenza okungezwe kunguqulo ngayinye.
  • Ukubonga: Isigaba esiqukethe ukwazisa kwabanye abantu noma izinhlangano ezinikele ngandlela thile kuphrojekthi.

Ukukhulisa lolu lwazi, ku- Imikhuba emihle ezindabeni ze imibhalo ngentuthuko ye Isofthiwe yamahhala, ngu "Code for Development Initiative" i-del Ibhange leNtuthuko yaseMelika ungachofoza kusixhumanisi esilandelayo: Imibhalo - Umhlahlandlela wokushicilela amathuluzi edijithali. Futhi kokunye ukushicilelwa sizohlola ingxenye ebhekise kwi imikhuba emihle mayelana ne ukuhlolwa kanye nokuthola amalayisense i-del Isoftware Emahhala neVulekile ngokwabo.

Isiphetho

Isiphetho

Siyethemba ukuthi lokhu "okuthunyelwe okuwusizo okuncane" cishe «Buenas prácticas» emkhakheni we «documentación» ukudala lapho kuthuthukiswa «Software libre y abierto», yiba nentshisekelo nokusetshenziswa okuhle, kwayo yonke «Comunidad de Software Libre y Código Abierto» kanye negalelo elikhulu ekusabalalisweni kwesimangaliso semvelo, esikhulu futhi esikhulayo sokusebenzisa kanye nokwenzelwe «GNU/Linux».

Futhi ukuthola eminye imininingwane, unganqikazi njalo ukuvakashela noma yikuphi Umtapo wolwazi oku-inthanethi njengoba I-OpenLibra y I-JedIT ukufunda izincwadi (ama-PDF) ngalesi sihloko noma ezinye izindawo zolwazi. Okwamanje, uma ukuthandile lokhu «publicación», ungayeki ukuyaba nabanye, ku- Amawebhusayithi ayizintandokazi, iziteshi, amaqembu, noma imiphakathi zokuxhumana nabantu, okungcono mahhala futhi evulekile njenge I-mastodon, noma ukuphepha nokuyimfihlo kwangasese yocingo.

Noma mane uvakashele ikhasi lethu lasekhaya ku- KusukaLinux noma ujoyine iSiteshi esisemthethweni Yocingo kusuka ku-DesdeLinux ukufunda nokuvotela lokhu noma ezinye izincwadi ezithakazelisayo ku- «Software Libre», «Código Abierto», «GNU/Linux» nezinye izihloko ezihlobene ne- «Informática y la Computación»kanye «Actualidad tecnológica».


Okuqukethwe yi-athikili kunamathela ezimisweni zethu ze izimiso zokuhlelela. Ukubika iphutha chofoza lapha.

Yiba ngowokuqala ukuphawula

Shiya umbono wakho

Ikheli lakho le ngeke ishicilelwe.

*

*

  1. Ubhekele imininingwane: Miguel Ángel Gatón
  2. Inhloso yedatha: Lawula Ugaxekile, ukuphathwa kwamazwana.
  3. Ukusemthethweni: Imvume yakho
  4. Ukuxhumana kwemininingwane: Imininingwane ngeke idluliselwe kubantu besithathu ngaphandle kwesibopho esisemthethweni.
  5. Isitoreji sedatha: Idatabase ebanjwe yi-Occentus Networks (EU)
  6. Amalungelo: Nganoma yisiphi isikhathi ungakhawulela, uthole futhi ususe imininingwane yakho.

i-bool(iqiniso)