ohwyy_proj_template

Template for starting Oceanhackweek project repos.

This repo is an example of how teams can structure their project repositories and format their project README.md file, but feel free to adapt as suits your needs.

Folder Structure

• contributor_folders (optional) Each contributor can make a folder here and push their work here during the week. This will allow everyone to see each others work but prevent any merge conflicts. It is good if participants are new to collaborative coding.
• final_notebooks When the team develops shared final notebooks, they can be shared here. Make sure to communicate so that you limit merge conflicts.
• scripts Shared scripts or functions can be added here.
• data Shared dataset can be shared here. Note, do not put large datasets on GitHub. Speak to the organizers if you need to share large datasets. Each team member can have a version of the dataset locally in the same folder to preserve relative paths, but the dataset does not need to be added to git/GitHub (you can use .gitignore).

You can start with a simple structure and as you progress you can refine it to contain more components. Here is an example of a more elaborate structure for a data science project.

Project Name

One-line Description

Collaborators

Name	Role
Participant 1
Participant 2
Participant 3

Planning

• Initial idea: "short description"
• Ideation Slide: Add link
• Slack channel: ohw26_proj_name
• Final presentation: Add link

Background

Goals

Datasets

Workflow/Roadmap

Results/Findings

Lessons Learned

References