Fejlesztés¶
Ha ezt olvasod, valószínűleg érdekel, hogyan járulhatsz hozzá az Odoo kódbázisához. Akár ez a helyzet, akár véletlenül kerültél ide, mi segítünk neked!
Amikor készen állsz, ugorj a Környezet beállítása szakaszra, hogy megkezdhesd az Odoo fejlesztéséhez való hozzájárulásod útját.
Környezet beállítása¶
Az alábbi utasítások segítenek előkészíteni a környezetedet a kódbázis helyi módosításainak elvégzéséhez, majd azok GitHub-ra való feltöltéséhez. Hagyd ki ezt a részt, és menj a Tegye meg az első hozzájárulását részhez, ha már elvégezted ezt a lépést.
Először is, hozzon létre egy GitHub fiókot. Az Odoo a GitHub-ot használja termékei forráskódjának kezelésére, és itt fogja elvégezni a változtatásokat és benyújtani azokat felülvizsgálatra.
Új SSH kulcs generálása és regisztrálása a GitHub fiókjában.
Menj a github.com/odoo/odoo oldalra, és kattints a jobb felső sarokban található Fork gombra, hogy létrehozz egy forkot (saját másolatod) a fiókodban lévő tárról. Tedd ugyanezt a github.com/odoo/enterprise oldalon, ha hozzáférsz. Ez létrehoz egy másolatot a kódbázisról, amelyen módosításokat végezhetsz anélkül, hogy a fő kódbázist befolyásolnád. Hagyd ki ezt a lépést, ha az Odoo-nál dolgozol.
Telepítsd a Git-et. Ez egy parancssori (szöveges felület) eszköz, amely lehetővé teszi a fájlhoz végzett módosítások történetének nyomon követését, és ami még fontosabb, a fájl különböző verzióin való egyidejű munkát. Ez azt jelenti, hogy nem kell aggódnod amiatt, hogy felülírod valaki más függőben lévő munkáját, amikor módosításokat végzel.
Ellenőrizd, hogy a Git telepítési könyvtára szerepel-e a rendszered
PATHváltozójában.Kövesd a útmutatót a PATH változó frissítéséhez Linux és macOS rendszeren a Git telepítési útvonalával (alapértelmezés szerint
/usr/bin/git).Kövesse a útmutatót a PATH változó frissítéséhez Windows alatt a Git telepítési útvonalával (alapértelmezés szerint
C:\Program Files\Git).Konfigurálja a Git-et, hogy azonosítsa magát, mint a jövőbeli hozzájárulásai szerzője. Adja meg ugyanazt az email címet, amelyet a GitHub-ra való regisztrációkor használt.
$ git config --global user.name "Your Name" $ git config --global user.email "[email protected]"
Telepítse az Odoo-t a forrásokból. Győződjön meg róla, hogy a forrásokat Git-en keresztül SSH-val tölti le.
Konfigurálja a Git-et úgy, hogy a változtatásokat a saját fork(ok)jára tolja, nem pedig a fő kódbázisra. Ha az Odoo-nál dolgozik, konfigurálja a Git-et úgy, hogy a változtatásokat a odoo-dev fiókon létrehozott megosztott forkokra tolja.
Az alábbi parancsban cserélje le a
<your_github_account>-ot annak a GitHub fióknak a nevére, amelyen a fork(ok)at létrehozta.$ cd /CommunityPath $ git remote add dev [email protected]:<your_github_account>/odoo.git
Ha hozzáférése van az
odoo/enterprise-hoz, konfigurálja a kapcsolódó távoli elérést is.$ cd /EnterprisePath $ git remote add dev [email protected]:<your_github_account>/enterprise.git
$ cd /CommunityPath $ git remote add dev [email protected]:odoo-dev/odoo.git $ git remote set-url --push origin you_should_not_push_on_this_repository $ cd /EnterprisePath $ git remote add dev [email protected]:odoo-dev/enterprise.git $ git remote set-url --push origin you_should_not_push_on_this_repository
Ennyi! Készen áll arra, hogy megtegye az első hozzájárulását.
Tegye meg az első hozzájárulását¶
Fontos
Odoo development can be challenging for beginners. We recommend you to be knowledgeable enough to code a small module before contributing. If that is not the case, take some time to go through the developer tutorials to fill in the gaps.
Ennek az útmutatónak néhány lépése megköveteli, hogy kényelmesen kezelje a Git-et. Itt talál néhány útmutatót és egy interaktív képzést, ha elakadna valahol.
Most, hogy a környezete be van állítva, elkezdhet hozzájárulni a kódbázishoz. Egy terminálban navigáljon arra a könyvtárra, ahol az Odoo-t forrásból telepítette, és kövesse az alábbi útmutatót.
Choose the version of Odoo to which you want to make changes. Keep in mind that contributions targeting an unsupported version of Odoo are not accepted. This guide assumes that the changes target Odoo 18, which corresponds to branch
18.0.Create a new branch starting from branch 18.0. Prefix the branch name with the base branch:
18.0-.... If you work at Odoo, suffix the branch name with your Odoo handle:18.0-...-xyz.Example
$ git switch -c 18.0-fix-invoices
$ git switch -c 18.0-fix-invoices-xyz
Sign the Odoo CLA if not already done. Skip this step if you work at Odoo.
Végezze el a kívánt változtatásokat a kódbázison. Amikor a kódbázison dolgozik, kövesse ezeket a szabályokat:
Tartsa a változtatásait fókuszáltan és specifikusan. A legjobb, ha egyszerre egy adott funkción vagy hibajavításon dolgozik, ahelyett, hogy több, egymással nem összefüggő változtatást próbálna meg egyszerre kezelni.
Tartsa tiszteletben a stabilitási irányelvet, amikor más ágon dolgozik, mint a
master.Kövesse a kódolási irányelveket.
Tesztelje alaposan a módosításait, és írjon teszteket, hogy biztosítsa, minden a várakozásoknak megfelelően működik, és nincsenek visszalépések vagy nem szándékolt következmények.
Kötelezze el a módosításait. Írjon egyértelmű commit üzenetet a Git irányelvek szerint.
$ git add . $ git commit
Tolja fel a módosítását a forkjára, amelyhez hozzáadtuk a
devtávoli alias-t.Example
$ git push -u dev 18.0-fix-invoices-xyz
Nyisson egy PR-et a GitHubon, hogy benyújtsa a módosításait felülvizsgálatra.
Menjen az odoo/odoo kódbázis összehasonlító oldalára, vagy az odoo/enterprise kódbázis összehasonlító oldalára, attól függően, hogy melyik kódbázisra irányulnak a módosításai.
Select 18.0 for the base.
Kattintson a compare across forks gombra.
Válassza ki a <your_github_account>/odoo vagy <your_github_account>/enterprise fejlesztői adattárat. Cserélje le a
<your_github_account>-ot arra a GitHub fióknévre, amelyen létrehozta a forkot, vagy odoo-dev-re, ha az Odoo-nál dolgozik.Tekintse át a módosításait, és kattintson a Create pull request gombra.
Jelölje be a Allow edits from maintainer jelölőnégyzetet. Hagyja ki ezt a lépést, ha az Odoo-nál dolgozik.
Töltse ki a leírást, majd kattintson újra a Create pull request gombra.
Az oldal alján ellenőrizze az egyesíthetőségi státuszt, és kezelje az esetleges problémákat.
As soon as your PR is ready for merging, a member of the Odoo team is automatically assigned for review. If the reviewer has questions or remarks, they will post them as comments and you will be notified by email. Those comments must be resolved for the contribution to go forward.
Miután a módosításait jóváhagyták, a felülvizsgálat egyesíti azokat, és a következő kódfrissítés után elérhetővé válnak minden Odoo felhasználó számára!