Part 4: Pushing to GitHub

See our YouTube tutorial for a video demonstration of this section.

Putting the MDAKit on GitHub will fulfill the requirement that the Kit be hosted on a version-controlled repository, and finalise the continuous integration set up in the previous step.

During the cookiecutter generation process, the target GitHub repository <repo_name> was identified, and inserted into the workflows configuration as well as into the README.md file.

  1. Add this repository as a remote to the local git repository, e.g.:

    $ git remote add origin [email protected]:myusername/rmsfkit

    (substituting myusername for your GitHub username). Make sure that this repository exists on GitHub and is empty.

  2. Then, push the local code to GitHub:

    $ git push origin main

The rmsfkit repository on GitHub will now be up-to-date the local repository you have been working on. Navigate to Actions on GitHub to see the status of the tests. If all was done correctly in the previous sections, these will all pass!

Progress: MDAKit requirements

  1. ✓ Uses MDAnalysis

  2. ✓ Open source + OSI license

  3. ✓ Versioned + on a version-controlled repository – our code is now on GitHub.

  4. ✓ Designated authors and maintainers

  5. (At least) minimal documentation

  6. ✓ (At least) minimal regression tests – CI should be up and running, and the tests added in the last step all passing.

  7. ✓ Installable as a standard package

  8. ✓ (Recommended) community information available

  9. (Recommended) on a package distribution platform