GitHub Repository Conventions

GitHub Repository Conventions#

A collection of conventions used for the QuantEcon GitHub organization.

Naming Repositories#

Please use the following naming conventions

  1. Always use characters that do not require the use of shift key (i.e. ‘-’ rather than ‘_’)

Lectures#

Name

Description

Visibility

lecture-{name}

A repository that contains an official QuantEcon lecture series

public

lecture-{name}.notebooks

A companion repository that contains notebooks for an official QuantEcon lecture series

public

Books#

Name

Description

Visibility

book-{name}

A QuantEcon associated textbook repo

private

book-{name}.public

A QuantEcon textbook companion site

public

quantecon-book-{name}

(optional) A QuantEcon companion software package to support an official textbook project

public

Projects#

Name

Description

Visibility

project-{name}

A repository that contains a QuantEcon project (i.e. project-lecture-mojo)

Operational#

Reserved names for QuantEcon operations

Name

Description

grant-admin

Repository for grant administration

grant-fundraising

Repository for proposal development of funding opportunities