This document provides guidelines for people who want to contribute to the project.
Please use the bugtracker [1] before starting some work:
- check if the bug or feature request has already been filed. It may have been answered too!
- else create a new ticket.
- if you plan to contribute, tell us, so that we are given an opportunity to give feedback as soon as possible.
- Then, in your commit messages, reference the ticket with some
refs #TICKET-IDsyntax.
- Work in forks and branches, use git-flow.
- Prefix your branch with the ticket ID corresponding to the issue. As an
example, if you are working on ticket #23 which is about contribute
documentation, name your branch like
feature/23-contribute-docusinggit flow feature start 23-contribute-doc.
System requirements:
Python [2] version 2.7, available as
pythoncommand.Note
You may use Virtualenv [3] to make sure the active
pythonis the right one.make and wget to use the provided Makefile.
Docker [4] is the suggested tool to setup and run Odoo service. Continuous integration uses Docker. See
docker-compose.ymland.travis.yml.Docker is used to serve Odoo at
http://localhost:8069, with useradmin, passwordadminand databasetest. These values will be used within odooselenium's own tests.
Execute:
git clone [email protected]/meta-it/odooselenium.git
cd odooselenium/
make testIf you cannot execute the Makefile, read it and adapt the few commands it contains to your needs.
A Makefile is provided to ease development. Use it to:
- run tests:
make test
The Makefile is intended to be a live reference for the development environment.
Use the Makefile.
References
| [1] | https://github.com/meta-it/odooselenium/issues |
| [2] | https://www.python.org |
| [3] | https://virtualenv.pypa.io/en/latest/ |
| [4] | https://www.docker.com/ |