13. Contributing

This chapter contains documents that should be read and considered if one wants to contribute to itom or one of its plugins. It mainly consists of descriptions of different style guides, that are used within the itom project to provide a common code representation, as well as an introduction to translations of itom or its plugins.

• 13.1. CMake Style Guide
  • 13.1.1. General
  • 13.1.2. Indentation
  • 13.1.3. Naming
  • 13.1.4. End commands
  • 13.1.5. Examples
  • 13.1.6. References
• 13.2. Git Pre-Commit Hooks
• 13.3. Translations
  • 13.3.1. General
  • 13.3.2. Adding translations for the itom core project
  • 13.3.3. Updating or creating new ts-files
  • 13.3.4. Location of ts-files
  • 13.3.5. Translating plugins or designerplugins
• 13.4. Python Docstrings
  • 13.4.1. General
  • 13.4.2. Docstrings for itom and its methods and classes
  • 13.4.3. References