Skip to main content
Ctrl+K
euclid_rag euclid_rag

euclid_rag

  • User guide
  • API
  • Change log
  • Contributing
  • User guide
  • API
  • Change log
  • Contributing

Section Navigation

Guides

  • Development guide
  • Release procedure
  • Contributing

Contributing#

Learn how to contribute to the euclid_rag open source project, including how to set up a development environment, run tests, and prepare a release.

Guides

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

previous

Change log

next

Development guide

This Page

  • Show Source

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.