GitHub Repo Guidelines

This is a checklist for all public repositories hosted on the Creative Commons GitHub organization. Not all repositories meet these criteria yet. Please notify us if a project you'd like to work on does not meet this checklist by opening a GitHub issue associated with the repository.

Required Items

All GitHub repositories should have the following items to be considered fully ready for external contributors.

Files

Additional Items

  • CI and code style linters that run automatically whenever new code is pushed (if applicable to the project).
  • At least a couple of automated tests (if applicable to the project).

Optional items

  • Issue templates. GitHub pulls the default templates from our .github repository automatically, but if you want/need to customize them, create them in your repository.
  • A pull request template. GitHub pulls the default template from our .github repository automatically, but if you want/need to customize it, create it in your repository.
  • Support resources. GitHub pulls the default SUPPORT.md file from our .github repository automatically, but if you want/need to customize it, create it in your repository.
  • Setting up branch protections that don't allow code to be merged in without tests passing or requires reviews for pull requests to be merged.

Standard Labels

All repositories must contain the following labels. CC staff have access to a script that you can run to make sure all repositories have this label.

Repositories may contain additional custom labels as well. It is recommended that custom labels be explained in the contribution guidelines for that project.

Name Color Description
bug #d73a4a Something isn't working
duplicate #cfd3d7 This issue or pull request already exists
enhancement #a2eeef New feature or request
good first issue #7057ff Good for newcomers
help wanted #008672 Seeking help from community
in progress #ffcc00 Currently being worked on
invalid #e4e669 This doesn't seem right
question #d876e3 Further information is requested
urgent #d93f0b Needs to be fixed ASAP
wontfix #ffffff This will not be worked on

CC Metadata file

Each repo should have a .cc-metadata.yml file in the root directory with the following structure:

  
    # Whether this GitHub repo is for a CC-led engineering project
    engineering_project: true
    # Name of the repository/project in English
    english_name: CC Catalog API
    # All technologies used
    technologies: Python, Django, Django REST Framework, Elasticsearch
    # Whether this repository should be featured on the CC Open Source site's "Projects" page
    featured: false
  

This metadata file is used in the Projects page. Repos that are marked as non-engineering projects are not displayed in the page and repos marked as featured as displayed at the top of the page. Repos should be marked as featured if we are actively looking for community contributions and have the bandwidth to review them quickly.

Repos without this metadata file are treated as engineering_projects: true and featured: false. A default is necessary since it will take time for us to clean up and add metadata to all our repos.

Back to top