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.

• 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
    • Overview
    • In detail
  • Installing TARDIS in develop mode
  • Workflow summary
  • Deleting your master branch
  • Updating the mirror of trunk
  • Making a new feature branch
  • The editing workflow
    • Overview
    • In more detail
  • Asking for your changes to be reviewed and/or merged
  • Making sure your Pull request stays up-to-date
    • Rebasing on trunk
    • Recovering from mess-ups
  • Reviewing and helping others with Pull Requests
• Release
  • Update the Changelog
  • Doing the actual release

• Procedure to update the reference data

• Continuous Integration
  • Testing and Documentation
    • Testing
    • Documentation
  • Setting up a secure pathway to github
    • Installing a ssh-key
    • Adding it as a deploy key
    • Adding your key locally and copying the known host name
  • Setting up Azure services
    • Adding a pipeline on Azure Devops
    • Adding the key to Azure’s secure files
    • Setting up the YAML file to deploy
      • Pipeline hierarchy
    • Installing and running a self hosted agent
    • Debugging
    • Additional references