Developing Hermine

We document here the Hermine-specific aspects of the code. The different FOSS components on which Hermine relies have their own, very useful doc:

• Django documentation

• Django REST Framework documentation

• Django filter

• Package URL (Purl) specification and its Python library

Contents

• Basic development workflow
  • Standard install
  • Working with DevContainer
• Coding standards
  • Developer Certificate of Origin
  • REUSE standard
  • Code linting
  • Naming conventions
  • Commit messages
• The Data Model
  • Models for license management
  • Models for validation rules
  • Models for internal product management
  • Models for 3rd party components
• Permissions
  • Permissions used by Hermine
  • Groups
• Custom tags for Django templates
  • licenseAllowedCSS()
  • licenseCopyleftCSS()
  • licenseFOSSCSS()
  • licenseReviewCSS()
• Tests
  • Running the tests
  • Coverage
• Monitoring performances