Mae cyfraniad i brosiect nad ydych yn ei berchen yn darllen fel gwaith dibynadwy ar CV pan fo'r cofnod yn enwi'n union beth wnaethoch chi iddo mewn gwirionedd: pull request penodol a gafodd ei uno, nam y gwnaethoch chi ei olrhain a'i drwsio, adolygiad a roesoch a helpodd i lywio newid rhywun arall, neu rôl cynnal a chadw (maintainer) sydd gennych yn y prosiect, yn hytrach na dim ond enw ystorfa (repository) wrth ymyl dolen. Mae gwaith cod agored yn wahanol i brosiect a adeiladwyd gennych eich hun mewn un ffordd bwysig: mae eich enw'n eistedd yn hanes y comits ochr yn ochr ag enwau cyfranwyr eraill, ar brosiect a oedd eisoes â'i gynhalwyr ei hun cyn i chi gyrraedd ac a barhaodd i redeg ar ôl i'ch newid gyrraedd, felly rhaid i'r cofnod nodi'ch rhan benodol chi'n union yn hytrach na gadael i ddarllenydd dybio eich bod yn berchen ar y prosiect cyfan.
Pam mae angen geiriad gwahanol ar linell cod agored i brosiect sy'n eiddo i chi
Ar gyfer prosiect a adeiladoch ac sydd o dan eich rheolaeth lawn, mae cyflwyno prosiectau ochr ar CV peiriannydd meddalwedd yn trafod disgrifio beth mae'n ei wneud, beth wnaethoch chi ei adeiladu ag ef, a beth newidiodd am eich bod wedi'i adeiladu. Mae cyfraniad cod agored yn gofyn cwestiwn gwahanol yn gyntaf, nid beth mae'r prosiect yn ei wneud, gan y gall y darllenydd fel arfer chwilio am hynny mewn eiliadau os yw'r prosiect yn adnabyddus, ond beth wnaethoch chi'n benodol y tu mewn i brosiect a oedd eisoes yn bodoli ac eisoes â'i gyfeiriad ei hun. Gall llinell aneglur wrth ymyl enw prosiect adnabyddus, heb ddisgrifiad o'ch cyfranogiad go iawn, ddarllen fel ymgais i fenthyg enw da'r prosiect hwnnw yn hytrach na disgrifio gwaith go iawn, sy'n union groes i'r hyn y dylai'r llinell honno ei gyflawni.
Y mathau o gyfraniad sy'n werth eu henwi'n benodol
Pull request a unwyd yw'r uned gyfraniad fwyaf clir i'w henwi, ac mae enwi beth a newidiodd yn bwysicach na dim ond nodi ei fod yn bodoli: trwsio nam penodol, nodwedd newydd, gwelliant perfformiad, neu ddarn o ddogfennaeth a oedd ar goll. Mae adolygu cod yn waith go iawn, gwerthfawr ar brosiect gweithredol, ac mae'n haeddu llinell ar wahân i'ch newidiadau eich hun a unwyd pan fyddwch wedi gwneud digon ohono i fod o bwys, yn enwedig ar brosiect lle mae ansawdd adolygu'n rhan o sut mae cynhalwyr yn barnu safle cyfrannwr. Mae rôl cynnal a chadw neu ddidoli, lle mae gennych fynediad comit, yn adolygu pull requests pobl eraill, neu'n rheoli materion (issues) prosiect, yn haeddu ei llinell ei hun yn hytrach na chael ei chymysgu i grybwylliad cyffredinol o "gyfrannwr", oherwydd mae'n dweud rhywbeth nad yw un trwsiad a unwyd yn ei ddweud: bod cynhalwyr eraill yn ymddiried yn eich barn yn barhaus. Mae cyfraniadau cyson i'r un prosiect dros fisoedd lawer hefyd yn werth eu disgrifio fel patrwm yn hytrach na rhestru dim ond y newid a unwyd mwyaf trawiadol, gan fod patrwm yn darllen fel cyfranogiad parhaus yn hytrach na digwyddiad unwaith yn unig.
Enghraifft eglurhaol: llinell cyfraniad cod agored
Enghraifft eglurhaol, o aneglur i benodol. Aneglur: "Cyfrannwr, prosiect cod agored (github.com/example/project)." Penodol: "Cyfrannwr, offeryn llinell orchymyn cod agored a ddefnyddir ar gyfer amgylcheddau datblygu lleol. Trwsiodd nam a oedd yn achosi i'r offeryn hongian gyda ffeiliau ffurfweddu mawr, ac adolygodd sawl pull request gan gyfranwyr eraill i'r un ystorfa dros chwe mis." Mae'r fersiwn benodol yn enwi pwrpas y prosiect mewn un cymal, yn nodi'n union beth wnaeth y newid a unwyd ei drwsio mewn gwirionedd, ac yn gwahanu'r gwaith adolygu oddi wrth y trwsiad ei hun, yn hytrach na awgrymu bod y llinell gyfan yn disgrifio un cyfraniad yn unig.
Cydnabod gwaith a rennir heb honni gormod
Mae'r rhan fwyaf o newidiadau a unwyd ar brosiect cod agored gweithredol fel arfer wedi mynd trwy adolygiad rhywun arall cyn cael eu huno, ac mae cofnod CV sy'n awgrymu mai chi yw unig awdur nodwedd a luniwyd mewn gwirionedd gan sawl cynhalwr gyda'i gilydd yn darllen fel gorddweud cyn gynted ag y bydd rhywun yn gwirio hanes y comits, sy'n cymryd eiliadau'n unig i ystorfa gyhoeddus. Mae enwi eich cyfraniad penodol, un trwsiad, un nodwedd, un maes rydych yn ei adolygu'n rheolaidd, yn hytrach na disgrifio holl swyddogaeth y prosiect fel pe baech wedi'i adeiladu ar eich pen eich hun, yn cadw'r llinell yn onest ac, yn y rhan fwyaf o achosion, yn fwy penodol a dibynadwy na honiad ehangach. Lle mae sawl un o'ch cyfraniadau'n crynhoi o gwmpas un maes o brosiect, megis ei offer adeiladu neu ei set brofion, mae enwi'r maes hwnnw'n aml yn rhoi mwy o wybodaeth i'r darllenydd na rhestru sawl pull request bychan ar wahân.
Sut mae'n wahanol i brosiect sy'n perthyn i chi'n llwyr
Mae prosiect ochr a adeiladoch o'r dechrau'n haeddu llinell sy'n disgrifio ei bwrpas a'i ganlyniad, gan i chi wneud pob penderfyniad ynghylch beth mae'n ei wneud a sut. Mae cyfraniad cod agored yn haeddu llinell sy'n disgrifio'ch rhan benodol y tu mewn i benderfyniadau rhywun arall, gan fod cyfeiriad cyffredinol, pensaernïaeth a chwmpas y prosiect fel arfer eisoes wedi'u pennu cyn i chi ymuno. Mae'r ddau'n waith technegol dilys sy'n haeddu lle ar CV, ond mae cymysgu'r ddau, disgrifio cyfraniad cod agored yn yr un modd ag y byddech yn disgrifio'ch prosiect eich hun, yn tueddu naill ai i orbwysleisio'ch rôl yn y prosiect a rennir neu i danbwysleisio'r gwaith penodol go iawn a wnaethoch mewn gwirionedd.
Ble mae'n perthyn ar y CV
Mae cyfraniad cod agored sylweddol, neu rôl cynnal a chadw a gedwir dros amser, fel arfer yn haeddu ei linell ei hun mewn adran prosiectau ochr yn ochr â phrosiectau personol, gan fod y ddau'n disgrifio gwaith technegol y tu allan i swydd gyflogedig. Mae sawl cyfraniad llai ar draws prosiectau gwahanol yn aml yn well eu grwpio o dan un pennawd, megis "Cyfraniadau cod agored", gan enwi pob prosiect yn gryno yn hytrach na rhoi'r un pwysau gweledol i bedair llinell denau, tebyg iawn i'w gilydd, ag y byddai un cofnod wedi'i ddisgrifio'n dda yn ei gael. Mae templed Developer wedi'i adeiladu ag ardal prosiectau ochr yn ochr â'r hanes gwaith, sy'n gweddu i'r math hwn o gofnod p'un a dyfodd allan o swydd neu a yw'n sefyll ar wahân yn llwyr.
Ychwanegwch ef at eich CV
Mae cyfraniad cod agored, wedi'i ddisgrifio'n benodol a'i gydnabod yn onest, yn dystiolaeth go iawn o farn dechnegol y gall darllenydd yn aml ei gwirio'n uniongyrchol. Dechreuwch gyda templed a adeiladwyd ar gyfer gwaith peirianneg ac ychwanegwch eich cyfraniadau yn y golygydd, lle gallwch barhau i fireinio'r geiriad wrth i gyfraniadau newydd gyrraedd.