És difícil. Sempre ho és, quan es fa quelcom per primera vegada. Sobretot quan es col·labora amb altres, ja que equivocar-se no és gens agradable. Volem simplificar la manera d'aprendre a contribuir i col·laborar en projectes de codi obert per primera vegada.
Llegir articles i mirar tutorials pot ser útil, però què millor que fer les coses en un entorn pràctic real? Aquest projecte és una guia per a principiants que vol simplificar la primera contribució a projectes de codi oberts. Si vols fer la teva primera contribució, segueix les instruccions que es mostren a continuació:
Si no et sents còmode/a amb la línia d'ordres (Command Line), aquí trobaràs tutorials utilitzant eines que tenen Interfície Gràfica (GUI)
Si no tens git al teu ordinador, l'hauràs d'instal·lar.
Fes una 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 al teu compte de GitHub.
Clona aquest repositori al teu ordinador: ves al teu compte de GitHub, fes clic al botó clonar "clone or download" del repositori, i després clica a la icona de copiar al porta-retalls.
Obre una terminal/línia d'ordre i executa el següent comandament de git:
git clone "url que acabes de copiar"
on "url que acabeu de copiar" (sense cometes dobles) és la url per a aquest repositori (la vostra bifurcació o fork d'aquest projecte). Per obtenir la url, torna als passos anteriors.
Per exemple:
git clone https://github.com/aquest-soc-jo/first-contributions.git
on aquest-soc-jo
és el teu nom d'usuari de GitHub. En aquest pas, estàs copiant el contingut del repositori first-contributions de GitHub al teu ordinador.
Canvieu al directori del repositori del vostre ordinador (si no hi esteu allà ja):
cd first-contributions
Crea una nova branca (branch) utilitzant el comandament git checkout
:
git checkout -b <afegiu-el-nom-de-la-nova-branca>
Per exemple:
git checkout -b add-nom-cognom
(No fa falta que el nom de la branca contingui la paraula add però és recomanable, ja que l'objectiu d'aquesta branca és afegir el teu nom a la llista.)
Obre l'arxiu Contributors.md
en un editor de text i afegeix-hi el teu nom. No l'afegeixis ni al principi, ni al final de l'arxiu. Posa'l en qualsevol altre posició. Llavors desa l'arxiu.
Ara, si vas al directori del projecte i executes el comandament git status
, veuràs els canvis.
Afegeix aquests canvis a la branca que acabes de crear utilitzant el comandament git add
:
git add Contributors.md
Confirma (commit) els canvis utilitzant el comandament git init
:
git commit -m "Add <el-meu-nom> to Contributors list"
reemplaçant <el-meu-nom>
amb el teu nom.
Envia els canvis utilitzant el comandament 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 has creat anteriorment.
Si ara vas al teu respositori a GitHub, veuràs un botó Compare & pull request
(Compara i fes una solicitud d'incorporació). Fes clic en aquest botó.
Envia la solicitud d'incorporació (pull request).
Quan un administrador vegi la solicitud, la revisarà i incorporarà els teus canvis a la branca principal (main branch) del projecte. Rebràs una notificació per correu electrònic quan els canvis s'hagin incorporat.
Enhorabona! Acabes de completar el procés de treball principal que et trobaràs com a col·laborador de projectes de codi obert: fork -> clone -> edit -> PR.
Ara, celebra la teva contribució i comparteix-la amb els teus amics i seguidors anant a la web.
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.
A continuació, et pots preparar per contribuir a altres projectes. Hem reunit una llista de projectes amb tasques (issues) pendents fàcils per tal de poder començar. Fes un cop d'ull a la llista de projectes aquí.
GitHub Desktop | Visual Studio 2017 | GitKraken | Visual Studio Code | Atlassian Sourcetree | IntelliJ IDEA |