Download as DOCX, PDF, TXT or read online from Scribd
Download as docx, pdf, or txt
You are on page 1/ 2
Development
If you are reading this, chances are that you are interested in learning how to contribute to the codebase of Odoo. Whether that’s the case or you landed here by accident, we’ve got you covered!
Ver también
Discover other ways to contribute to Odoo
When you feel ready, jump to the Environment setup section to begin your journey in contributing to the development of Odoo.
Environment setup
The instructions below help you prepare your environment for making local changes to the codebase and then push them to GitHub. Skip this section and go to Make your first contribution if you have already completed this step.
1. First, you need to create a GitHub account. Odoo uses GitHub to manage the source code of its products, and this is where you will make your changes and submit them for review.
2. Generate a new SSH key and register it on your GitHub account.
3. Go to github.com/odoo/odoo and click on the Fork button in the top right corner to create a fork (your own copy) of the repository on your account. Do the same with github.com/odoo/enterprise if you have access to it. This creates a copy of the codebase to which you can make changes without affecting the main codebase. Skip this step if you work at Odoo.
4. Install Git. It is a command-line (a text interface) tool that allows tracking the history of changes made to a file and, more importantly, working on different versions of that file simultaneously. It means you do not need to worry about overwriting someone else’s pending work when making changes.
Verify that the installation directory of Git is included in your system’s PATH variable.
Linux and macOSWindows
Follow the guide to update the PATH variable on Linux and macOS with the installation path of Git (by default /usr/bin/git).
5. Configure Git to identify yourself as the author of your future contributions. Enter the same email address you used to register on GitHub.
8. Install Odoo from the sources. Make sure to fetch the sources through Git with SSH. 9. Configure Git to push changes to your fork(s) rather than to the main codebase. If you work at Odoo, configure Git to push changes to the shared forks created on the account odoo-dev.
Link Git with your fork(s)Link Git with odoo-dev
In the command below, replace <your_github_account> with the name of the GitHub account on which you created the fork(s).
$ cd /CommunityPath
$ git remote add dev git@github.com:<your_github_account>/odoo.git
If you have access to odoo/enterprise, configure the related remote too.
