Developer guide

This part of neophiles’s documentation contains some supplemental information primarily of interest to people doing development on neophile itself.

The neophile code structure partly but not entirely follows the guidelines in SQR-072.

Guides

• Development guide
  • Scope of contributions
  • Setting up a local development environment
  • Pre-commit hooks
  • Running tests
  • Building documentation
  • Updating the change log
  • Style guide
    • Code
    • Documentation
• Release procedure
  • Regular releases
    • 1. Change log and documentation
    • 2. Tag the release
    • 3. Create a GitHub release
  • Backport releases
    • Creating a release branch
    • Developing on a release branch
    • Releasing from a release branch

Reference

• Python internal API
  • neophile Package
  • neophile.analysis.base Module
  • neophile.analysis.pre_commit Module
  • neophile.analysis.python Module
  • neophile.cli Module
  • neophile.config Module
  • neophile.exceptions Module
  • neophile.factory Module
  • neophile.inventory.github Module
  • neophile.inventory.version Module
  • neophile.models.dependencies Module
  • neophile.pr Module
  • neophile.processor Module
  • neophile.repository Module
  • neophile.scanner.base Module
  • neophile.scanner.pre_commit Module
  • neophile.update.base Module
  • neophile.update.pre_commit Module
  • neophile.update.python Module