README.md

ATTENTION: This project repository has been archived in favor of https://github.com/uwhackweek/sample_project_repository. This repo is no longer maintained.

Sample Project

This is as an example on how teams can structure their project repositories. Thanks to Lindsey Heagey and Joachim Meyer for the template, provided originally for Geohackweek.

Files

• .gitignore
  Globally ignored files by git for the project.
• environment.yml
conda environment description needed to run this project.
• README.md
  Description of the project. Sample

Folders

contributors

Each team member has it's own folder under contributors, where he/she can work on their contribution. Having a dedicated folder for one-self helps to prevent conflicts when merging with master.

notebooks

Notebooks that are considered delivered results for the project should go in here.

scripts

Helper utilities that are shared with the team