Github Standards

All projects being worked on with associated code MUST have a repository in the OUIDEAS group (github.com/OUIDEAS). All repositories must be aptly named for the project it is. For example, "[INSERT NAME] Code" is NOT acceptable.

All repositories must have README files that explain the purpose and function of the code, as well as explain all relevant directories within the repo. EXPLAIN HOW TO USE YOUR CODE

If there are setup steps needed to run the code, explain them in the README.

All branches must be explained in the README
a. If the working branch is not main then in the README write:
“Working branch is x”

Outline all files of interest in the README
a. If there are files that can be run and have a purpose outside of what was described in the purpose statement, explain them. For example, if there is a script that can make a movie of collected data, point it out.

The corresponding data folder in the IDEASDrive should also be included in the README so that people know where to find your data.

Code outputs and expected data should be outlined in the README as well.
a. No binary data should be pushed to GitHub. Utilize the .gitignore file.

If you are NOT part of the OUIDEAS group, contact Dr. Wilhelm for access. Requests must be sent over Teams or in person.
a. Teams Message Outline:
“Hi Dr. Wilhelm, I need access to the OUIDEAS group so I can upload my code for [INSERT PROJECT NAME]. Here is my GitHub username: [INSERT GITHUB USERNAME]. Thanks”
b. If an in-person request was made:
“Here’s my GitHub username per our conversation earlier. [INSERT GITHUB USERNAME]. Thanks”

Code should be pushed when significant progress has been made.

Push notes do NOT have to be long but should explain any major changes.
a. Push notes can be included in weekly reports in addition to GitHub.