Skip to content

Home

Jump to bottom
Eric Daigle edited this page Jul 18, 2024 · 1 revision

COMET Wiki

Welcome to the COMET wiki. Here you'll find important documents to read if you're interested in using or contributing to our the project.

Key Documents

The most important documents can be found in the repository:

  • The CODE_OF_CONDUCT.md file contains our project code of conduct, which all members and contributors are expected to follow.
  • The DEVELOPING.md file contains an overview of the workflow used to hack on COMET.
  • The LICENSE file contains our project's open-source license statement.

Repository Commit Guidelines

It is very important that you follow these guidelines when committing work to the repository, in order to keep things well-organized.

There are two special branches: main and pages.

  • main is the current "completed" set of modules or units, ready for deployment.
  • pages is a special branch which is reserved for website deployment.
  1. Do not commit to either pages or main without specific guidance to do so. Always change these branches through a merge request instead.
  2. Keep each new module or unit on its own branch: when you start working on a new module, create a new branch of main to store your work with a descriptive name. Don't use an existing branch for a new modules.
  3. When you are finished a module, create a merge request for it back to main, and delete the old branch if you don't need it.

Ensure that you keep your commits clean and tidy:

  • Use a descriptive commit title and description
  • Make sure you have removed temporary files and other materials

Any commits or merge requests that do not meet these guidelines will be rejected and will need to be re-done.

Large Files Commit Guidelines

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 unmanagable degree. We are currently using the git Large File Storage system.

  • It is very important that you do not upload large binary files to the repository unless necessary. This includes:
    • .dta, .xls, .xlsx, .csv, .jpg, .docx, .tab: basically, anything that isn't an .r, .ipynb, .md, or small text tile
  • Please place all large data files in a the dedicated UBC OneDrive folder and copy the files to your notebook directory as-needed.
    • Create an issue to have the file managed by the LFS server and tag a maintainer.
  • This applies to files such as: (i) raw data, (ii) datasets, (iii) videos, (iv) large images. Anything roughly larger than 10 mb should be considered "large" for the purposes of this repository

Currently, the list of filetypes which should be automatically version controlled can be viewed in the .gitattributes file in the main repository.

Clone this wiki locally