Developer Workflow

If you want to contribute to the development of TARDIS, please read through this page and follow the guidelines outlined here. Many of the Development workflow is taken from Astropy, and credit belongs to the Astropy team for designing it.

• Reporting Issues
• General Workflow to add a new feature
• Preparation and Working with Git
  • Creating a fork
  • Set up and configure a GitHub account
  • Create your own fork of a repository
  • Setting up the fork to work on
  • Installing TARDIS in develop mode
  • Workflow summary
  • Deleting your master branch
  • Updating the mirror of trunk
  • Making a new feature branch
  • The editing workflow
  • Asking for your changes to be reviewed and/or merged
  • Making sure your Pull Request stays up-to-date
  • Reviewing and helping others with Pull Requests
• Documentation Guidelines
  • Documenting the code you write
  • Building documentation locally
  • Sharing the built documentation in your pull request
  • Troubleshooting Your Documentation
• Running tests
  • Running the Unit Tests
  • Generating Plasma Reference
  • Running the Integration Tests
• Benchmarks
  • AirSpeed Velocity (ASV)
  • Installation
  • Set up
  • Execution
  • Visualization
• Code Quality Guidelines
  • Code Style Conventions
  • Docstrings
  • Edge Cases and Exception Handling
• Developer FAQ

TARDIS core team Instructions

Following are advanced development guidelines that are mainly intended for the core team (active maintainers) of TARDIS.

• Continuous Integration
  • GitHub Actions
  • Common Steps
• Update the Regression Data
• Matterbridge Server
  • Overview
  • Configuration
  • First-time setup
  • Update server configuration
  • Cron job
• Debugging numba_montecarlo