Skip to content

Coding Practices

Jack Radcliffe edited this page Mar 22, 2017 · 1 revision

To make sure that we don't commit code that doesn't work, we need to do the following steps when making ANY changes to the master branch:

  1. Fork the target repo to your own account.
  2. Clone the repo to your local machine.
  3. Check out a new "topic branch" and make changes.
  4. Push your topic branch to your fork.
  5. Use the diff viewer on GitHub to create a pull request via a discussion.
  6. Make any requested changes.
  7. The pull request is then merged (usually into the master branch) and the topic branch is deleted from the upstream (target) repo.

Some CASA pipeline code specifics:

If making any changes to the name of input dictionary e.g.

 if processes['run_importuvfits'] == 1: to if processes['importuvfits'] == 1:

Or if you are adding a new entry to the variable processes,

Please make an issue and tag @jradcliffe5 so that I can update the GUI file (yes this file is a behemoth of a mess).

Clone this wiki locally