This is as an example on how teams can structure their project repositories. Thanks to Lindsey Heagey and Joachim Meyer for the template!
.gitignore
Globally ignored files bygitfor the project.environment.yml
condaenvironment description needed to run this project.README.md
Description of the project (see suggested headings below)
Each team member has it's own folder under contributors, where they can work on their contribution. Having a dedicated folder for each person helps to prevent conflicts when merging with the main branch.
Notebooks that are considered delivered results for the project should go in here.
Helper utilities that are shared with the team
Brief title describing the proposed work.
List all participants on the project. Choose one team member to act as project lead, and identify one hackweek organizer as the data science lead.
What problem are you going to explore? Provide a few sentences. If this is a technical exploration of software or data science methods, explain why this work is important in a broader context.
List one specific application of this work.
If you already have some data to explore, briefly describe it here (size, format, how to access).
List the specific tasks you want to accomplish or research questions you want to answer.
How would you or others traditionally try to address this problem?
Building from what you learn at this hackweek, what new approaches would you like to try to implement?
Optional: links to manuscripts or technical documents for more in-depth analysis.