Skip to content

Repository structure

Jump to bottom
mjt320 edited this page Mar 24, 2021 · 10 revisions

WIP

Branch Structure

Folder Structure

The main components of the repository comprise 3 folders and the configuration files for automated testing.

The doc folder contains all documentation pertaining to the operation of TF 2.3.

The src folder contains the community contributed src code. Within src, the original folder contains the code to be tested, and the tested folder will house code that has been tested in the current or previous milestones. Within these folders, contributions are stored in Functionality/Initials_InstitutionCountry, e.g. src/original/T1/AB_YaleUSA.

The test folder contains the test files corresponding to the contributed code in src. Each contributed source code will have a corresponding test file in this folder. The directory structure does not necessarily have to mirror that of the src folder.

Click here for database of code available and testing status

For people contributing code to the Collection:

About the Collection
Repository structure
How to contribute code

For members developing tests for the Collection:

The testing approach
Testing procedure
Pytest basics

For those looking for code to use:

About the Collection
Repository structure
The testing approach
Finding code and viewing test results
Python Dependency List

Other:

Authorship Policy

Clone this wiki locally