És difícil. Sempre ho és quan es fa algo per primera vegada. Especialment quan es col·labora amb altres, ja que efectuar errades no es gens agradable. Es vol simplificar la manera en que els col·laboradors de codi obert aprenen i contribueixen per primera vegada.
Llegir articles i mirar tutorials pot ser d'ajuda, però què millor que fer les coses en un entorn de pràctiques? Aquest projecte és una guia, simplificant la forma de fer la primera contribució per als principiants. Si voleu fer la primera contribució, seguiu les instruccions que es mostren a continuació:
Si no esteu còmode amb la línia d'ordres, aquí hi ha tutorials utilitzant eines amb Interfaç Gràfica (GUI)
Si no disposeu de git en el vostre ordinador, instal·leu-lo.
Feu un fork d'aquest repositori clicant al botó "Fork" a la part superior dreta d'aquesta pàgina. Això crearà una còpia d'aquest repositori en el seu compte.
Cloneu aquest repositori al vostre ordinador. Adreceu-vos al vostre compte de GitHub, cliqueu al botó clonar "clone or download" i després cliqueu a la icona de copiar al porta-retalls.
Obriu una terminal i executeu la següent comanda de git:
git clone "url que acabeu de copiar"
on "url que acabeu de copiar" (sense cometes dobles) és la url per a aquest respositori (el vostre fork d'aquest projecte). Veure els passos anteriors per a obtenir la url.
Per exemple:
git clone https://github.com/aquest-soc-jo/first-contributions.git
on aquest-soc-jo
és el vostre nom d'usuari de GitHub. Aquí esteu copiant el contingut del repository first-contributions de GitHub al vostre ordinador.
Canvieu al directori del repositori del vostre ordinador (si no hi esteu allà ja):
cd first-contributions
Creeu una nova branca (branch) utilitzant la comanda git checkout
:
git checkout -b <afegiu-el-nom-de-la-nova-branca>
Per exemple:
git checkout -b add-nom-cognom
(No és necessari que el nom de la branca contingui la paraula add, però es recomanable ja que el propòsit d'aquesta branca és afegir el seu nom a la llista.)
Obriu l'arxiu Contributors.md
en un editor de text i afegeiu el vostre nom. No l'afegiu ni al principi ni al final de l'arxiu. Poseu-lo en qualsevol altre posició. Guardeu l'arxiu.
Si aneu al directori del projecte i executeu la comanda git status
, veureu els canvis.
Afegiu aquests canvis a la branca que acabeu de crear utilitzant la comanda git add
:
git add Contributors.md
Confirmeu (commit) els canvis utilitzant la comanda git init
:
git commit -m "Add <el-meu-nom> to Contributors list"
reemplaçant <el-meu-nom>
amb el vostre nom.
Feu un Push dels canvis utilitzant la comanda git push
:
git push origin <afegiu-el-nom-de-la-branca>
reemplaçant <afegiu-el-nom-de-la-branca>
amb el nom de la branca que heu creat anteriorment.
Si aneu al vostre respositori a GitHub, veureu un botó Compare & pull request
. Cliqueu sobre aquest botó.
Envía la pull request.
Aviat estaré fusionant els vostres canvis en la branca (branch) master d'aquest projecte. Rebreu una notificació per correu electrònic un cop els canvis hagin sigut fusionats.
Enhorabona! Acabeu de completar l'estàndard flux de treball fork -> clone -> edit -> PR que trobareu sovint com a col·laborador!
Celebreu la vostra contribució i compartiu-ho amb els vostres amics i seguidors anant a web app.
Podeu unir-vos al nostre equip d'slack en cas de que necessiteu ajuda o tingueu alguna pregunta. Unir-se a l'equip d'slack.
Ara anem a preparar-nos per a contribuir a altres projectes. Hem reunit una llista de projectes amb îssues* facils per a que pugueu començar. Doneu un cop d'ull la llista de projectes en la web app.
GitHub Desktop | Visual Studio 2017 | GitKraken | Visual Studio Code | Atlassian Sourcetree | IntelliJ IDEA |