Skip to content

Latest commit

 

History

History
119 lines (75 loc) · 3.05 KB

README.rst

File metadata and controls

119 lines (75 loc) · 3.05 KB
Raw

cookiecutter-odoo

Travis CI build status

A modified cookiecutter template for OpenERP/Odoo.

Maturity

Alpha release. This template uses a modified version of cookiecutter templating system. To install this modified version, please do:

pip install git+https://github.com/0k/cookiecutter

We plan to have v7 and v8 template in the same repository with sane branch naming.

We intend to produce compatible and full project for corresponding branch in the odoo github repository.

Features

  • OpenERP/Odoo version:
    • Odoo 8.0
  • Include:
    • report
    • security
    • web (xml, css, js)
    • views
    • models

Usage

First install cookiecutter from our repositories:

$ pip install git+https://github.com/0k/cookiecutter

Now run with this repo:

$ cookiecutter gh:0k/cookiecutter-odoo

Branch selection can be done with --checkout:

$ cookiecutter gh:0k/cookiecutter-odoo --checkout 8.0

For more info about cookiecutter options and usage, please check cookiecutter documentation.

Please bear in mind that we are using a (minor) fork, that should remain compatible with all cookiecutter's features.

Contributing

Any suggestion or issue is welcome. Push request are very welcome, please check out the guidelines.

Push Request Guidelines

You can send any code. I'll look at it and will integrate it myself in the code base and leave you as the author. This process can take time and it'll take less time if you follow the following guidelines:

  • check your python code with PEP8 or pylint. Try to stick to 80 columns wide.
  • avoid tabs
  • separate your commits per smallest concern.
  • each commit should pass the tests (to allow easy bisect)
  • each functionality/bugfix commit should contain the code, tests, and doc.
  • prior minor commit with typographic or code cosmetic changes are very welcome. These should be tagged thanks to an ending !minor in their commit summary.
  • the commit message should follow gitchangelog rules (check the git log to get examples)
  • if the commit fixes an issue or finished the implementation of a feature, please mention it in the summary.

If you have some questions about guidelines which is not answered here, please check the current git log, you might find previous commit that would show you how to deal with your issue.

License

Copyright (c) 2012-2015 Valentin Lab.

Licensed under the BSD License.

Thanks