A repository for our the large TLEF project: Unpacking the Black Box: Critical AI Literacies for Arts Students.
You can find the most important documents here, in our repository:
- The
CODE_OF_CONDUCT.mdfile contains our project and repository code of conduct, which is expected that all members and contributors follow.
All of the other documentation is organized as outlined below.
You can find general details about this project in this document, in addition to the key files and formats. By contributing to this project, you agree to our project code of conduct.
It is very important that you follow these guidelines when committing work to the repository, in order to keep things well-organized.
- Do not commit directly to
main. Always commit via a merge request, from a branch. - Be responsible with branches:
- Delete old branches.
- Don't publish un-necessary local branches.
- Give branches sensible names.
- Make sure you have don't commit temporary files and other materials.
- Use good commit messages.
This repository is organized into several distinct parts, housed in the main branch's root directory.
- The directory
/metacontains general repository management files. - The directory
/projectcontains all the main project files, including the website./docscontains the notebooks and lesson plans./pagescontains the website material, distinct from the other content./mediaand/filescontain supplemental items.
- The directory
/documentationcontains all the project documentation, including the style guides.- Some of these are also included in the website.
We use the Quarto framework to write content and build the website, although we also can support raw .ipynb notebooks, as well.
Large files are problematic in Git: because they are stored as binaries any change to them (including inconsequential ones) creates a new version of the file, which is then stored in the repository's commit history. This means that the repo can quickly balloon in size to an unmanageable degree. We use the git Large File Storage system.
Currently, the list of filetypes which should be automatically version controlled is in the .gitattributes file in the main repository. However, you should avoid committing large files whenever possible.