Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1015 Bytes

Contributing to odoo-helper-scripts

Thank you for your interest in contributing to odoo-helper-scripts!

Contributing to this project

  1. Fork the repository on GitHub or GitLab
  2. Create a new branch, e.g., git checkout -b bug-12345 based on dev branch
  3. Fix the bug or add the feature
  4. Add or modify related help message (if necessary)
  5. Add or modify documentation (if necessary) for your change
  6. Add changelog entry for your change in Unreleased section
  7. Commit and push it to your fork
  8. Create Merge Request or Pull Request

How to build documentation

Install MkDocs

pip install mkdocs

Run build_docs script in repository root.

./scripts/build_docs.sh

Run MkDocs built-in dev server with following command in repository root.

mkdocs serve

Generated documentation will be available at http://127.0.0.1:8000/.