Testing, Documenting, and Reviewing Code

Self-learning course

Site Updated On: August 30, 2022
For More Info Email: richard.regan@durham.ac.uk
Testing, Documenting, and Reviewing Code

General Information

Requirements: Participants must have access to a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. They should have a few specific software packages installed (listed below).

Accessibility:

We are dedicated to providing a positive and accessible learning environment for all. Please get in touch you require any accommodations or if there is anything we can do to make this lesson more accessible to you.

Contact: Please email or richard.regan@durham.ac.uk for more information.


Surveys

Please be sure to complete this survey after the lesson.

Please input the date as the date you started the materials.

Post-Lesson Survey


Lesson Outline


Schedule

1. Test Strategy, Planning, and Running Tests Does the code we develop work the way it should do?
Can we (and others) verify these assertions for themselves?
To what extent are we confident of the accuracy of results that appear in publications?
2. Development Tools Are there any tools that can help make software development easier?
How can I locate faults in my code?
3. Reviewing Code How can others help me improve my code?
4. Documenting Code How should we document and license our code?
5. Survey
Finish

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.


Setup

To participate in this lesson, you will need access to software as described below. In addition, you will need an up-to-date web browser.

The instructions for all the software can be found on the setup page.