Skip to content

New Repository

Create New GitHub Repository

Use these steps to create an entirely new git repository in GitHub. All code stored in GitHub should be within the Hakai Institute organization. This applies to everything from collections of scripts to app development.

  1. Login to github.com
  2. Join the github.com/hakaiinstitute organization (email data@hakai.org)
  3. Click on the '+' sign (upper right corner)
  4. Select New Repository
  5. Change the Owner to HakaiInstitute to create this repo within Hakai
  6. Enter a repository name (the convention is to use all lowercase separated by hyphens)
  7. Keep visibility Public unless this project will contain sensitive data
  8. Important: Set the template to HakaiInstitute/hakai-dataset-repository-template1
  9. Important: Set Include all branches to On2
  10. Click Create repository

By protecting your main branch from certain actions, you will:

  • Reduce time spent troubleshooting and repairing your repository
  • Help new collaborators follow your team's workflows
  • Create a clean source of truth that is buffered from untested changes
  • Prepare for adding automation

Here is how to add a simple protection rule for your main branch:

  1. Open your repository in GitHub
  2. Click Settings (far right)
  3. Click Rules > Rulesets
  4. Click New ruleset > New branch ruleset
  5. Give it a name like "Protect Main Branch"
  6. Change Enforcement status to Active
  7. Click Add target under Target branches
  8. Click Include default branch
  9. Scroll down and check Require a pull request before merging
  10. (Recommended) Restrict the Allowed merge methods - contact data@hakai.org to discuss options
  11. Scroll to bottom and click the Create button

After creating a repository, you can Clone the repo to your computer to work on it.

  1. The 'hakai-dataset-repository-template' includes some initial built-in documentation to help you get started as well as many common defaults like the CC-BY-4.0 License, recommended project structure, and automation that helps new data packages find their way to the Hakai Data server. (See Mobilization > GitHub) ↩

  2. Including the default starter branches from the template allows the built-in automation to run, matches recommended best practices for git flow, and enables the Data Mobilization team to help you effectively manage your data. ↩