Contributing to the Odoo Community Association (OCA)
0 likes659 views
The document provides an overview of the Odoo Community Association (OCA), outlining its role as a nonprofit organization supporting 105 GitHub projects and offering ways to participate, such as testing modules, submitting code, and becoming a member. It details the process for contributing to the community, including signing a Contributor License Agreement and adhering to coding conventions, as well as resources for testing and review of code submissions. Additionally, it discusses membership benefits and the importance of supporting the association's activities.
Contributing to the Odoo Community Association (OCA)
- 1. Contributing to the Odoo Community Association (OCA) © Gary Larson
- 2. 2/20www.camptocamp.com / Come and talk with us at the OCA Booth Many thanks to the contributors of the OCA booth crowd funding campaign © Gary Larson
- 3. 3/20www.camptocamp.com / What is the OCA ? ■ A not for profit organization ■ http://odoo-community.org/ ■ Serves as umbrella for 105 github projects ○ https://github.com/OCA/ ○ Each hosting several Odoo addons ○ Development shared across 67 teams
- 4. 4/20www.camptocamp.com / How can you get involved? ■ Follow us ■ Test and review and use our modules ■ Submit code and documentation ■ Become a member
- 5. 5/20www.camptocamp.com / Follow us ■ The web site ■ The blog https://odoo-community.org/blog/news-1 ■ Twitter @OdooCommunity ■ The contributors mailing list https://odoo-community.org/groups/15
- 6. 6/20www.camptocamp.com / Participate ■ Test the modules ○ You can use http://runbot.odoo-community.org/ ■ Create a github account, and use it to report issues ■ Test and review pull requests ○ The runbot makes this easy
- 7. 7/20www.camptocamp.com / Propose documentation and code ■ You'll need to sign the Contributor License Agreement (CLA) ■ Make Pull Requests on the projects ○ Watch for the output of the CI tools ○ Wait for reviews, and discuss with the reviewers, improve your code ■ Try to keep a good submitted PR / reviewed PR ratio ○ Just submitting code and never doing reviews is abusing the ecosystem
- 8. 8/20www.camptocamp.com / The CLA ■ Gives some rights to the association over your contributions ■ The OCA is committed to open source by its by-laws ○ The association is allowed to relicense your contributions, but only to an OSI approved license ■ We have some CLA forms on the OCA booth
- 9. 9/20www.camptocamp.com / Coding conventions ■ Our coding conventions are documented in OCA/maintainer-tools ○ In the CONTRIBUTING.md file ○ There's a direct link from the OCA web site ■ Built on Odoo's official recommendations ○ With some added requirements ○ With some relaxed requirements
- 10. 10/20www.camptocamp.com / Github cheat sheet: making a PR $ git clone git@github.com:OCA/hr $ cd hr $ git remote add work git@github.com:account/hr $ git checkout -b 8.0-fix-stuff origin/8.0 # write code and tests, run tests until green $ git add -p $ git commit $ git push work Then browse to https://github.com/OCA/hr and click on the submit PR button
- 11. 11/20www.camptocamp.com / Our Continuous Integration tools © Gary Larson
- 12. 12/20www.camptocamp.com / Our Continuous Integration tools ■ Each PR is processed by TravisCI ○ Syntactatic / formatting checks with flake8 and pylint ○ Install the addons ○ Run tests using the odoo server facilities ■ For most repositories, PRs are also processed by the OCA runbot ○ This can be used to test the addons interactively
- 13. 13/20www.camptocamp.com / Code Reviews © Gary Larson
- 14. 14/20www.camptocamp.com / Reviewing a PR (1/3) ■ Check travis status ○ If red, figure out why (failure unrelated to the PR, flake8 issue, broken test…) ■ Read the information available to understand what the PR does ○ Commit message, README file… ○ If not clear ask the submitter for more information
- 15. 15/20www.camptocamp.com / Reviewing a PR (2/3) ■ Connect on runbot and try to use the module ○ Comment on usability issues on the PR ○ Include screen shots (easy to do on github) ○ Check for corner cases you can think of ■ If you are able to do this, check the code ○ Watch for untested places in the code ○ Think of other modules you know, and how this one will interact with them
- 16. 16/20www.camptocamp.com / Reviewing a PR (3/3) ■ Check the OCA coding conventions ■ Watch for issues for which we have no checks for now ○ Programming errors, bad API usage ○ Obscure code ○ Missing translations ○ … ■ When happy, say :+1:
- 17. 17/20www.camptocamp.com / Proposing a new project ■ You feel something is missing in the OCA landscape ○ Did you really check everywhere? ○ Ask on the contributors mailing list ○ Ask on Odoo community mailing list too ○ Gather people wanting to work on the topic ○ https://odoo-community.org/page/suggest-a-project
- 18. 18/20www.camptocamp.com / Becoming a member © Gary Larson
- 19. 19/20www.camptocamp.com / Becoming a member ■ It is not required to be a member of the association to be a contributor ■ Still, it is nice to support the association ○ Membership is for individuals only (no for-profit companies) ○ Your membership fees help cover for the runbot server costs, code sprint organisation costs… ○ https://odoo-community.org/shop