-
Notifications
You must be signed in to change notification settings - Fork 0
Data Storage
| File or Data Type | Storage Location | Commit to GitHub |
|---|---|---|
| Source code, scripts, models, configuration files, and project documentation | Appropriate project directory in this repository | Yes |
| Microsoft Office files used for collaboration or project administration | Project Microsoft Teams SharePoint | Normally no |
| Analysis datasets required to reproduce project results |
Data/GasTurb, Data/ReferenceData, or another descriptive directory under Data
|
Yes, when reasonably sized |
| Large data files used locally | Data/LocalData |
No |
| Large data files that must be shared with the team | Project Microsoft Teams SharePoint | No |
All project files that can reasonably be version controlled should be stored in this GitHub repository.
Examples include:
- MATLAB scripts and functions
- Configuration files
- Input files required to run project code
- Small or moderately sized output datasets needed to reproduce results
- Markdown documentation
- Text-based project files
Use the existing repository structure whenever possible. Create a new directory only when no existing location clearly fits the file.
Do not commit:
- Temporary files
- Software-generated cache files
- Personal working files
- Duplicate copies of files stored elsewhere
- Large files that belong in
Data/LocalData- This directory is ignored by default, so anything in there will not be pushed to GitHub
- Confidential or restricted information
All files committed to the repository must follow the project naming conventions and Git workflow.
Microsoft Office Suite files used for team collaboration should be stored in the project Microsoft Teams SharePoint.
This includes:
- Microsoft Word documents
- Microsoft Excel workbooks
- Microsoft PowerPoint presentations
- Meeting notes
- Planning documents
- Administrative documents
- Review packages
- Other files that require collaborative editing
SharePoint should be treated as the primary storage location for collaboratively edited Microsoft Office files.
Avoid maintaining uncontrolled copies in personal folders or committing duplicate Office files to GitHub.
When an Office document supports repository work, include a reference to its SharePoint location in the relevant:
- Markdown documentation
- GitHub issue
- Pull request
- Analysis notes
Final Copies of Reports and Presentations will be uploaded to GitHub as PDF.
Data files used directly by project analysis should be stored under the Data directory when their size is less than 20 MB.
Store GasTurb input or output data used by MATLAB or another analysis tool in:
Data/GasTurb