Submitting your repository to GitHub Community Exchange

You can submit your repository to GitHub Community Exchange for others to view or contribute to.

In this article

About repository submissions

Only public repositories owned by personal accounts can be submitted to GitHub Community Exchange.

There are three types of repository submissions:

  • Learn. A repository to share step-by-step instructions to build a project.
  • Collaborate. A repository seeking collaborators to work on a project.
  • Learn and Collaborate. A repository which is a combination of Learn and Collaborate.

Consider what the main purpose of your repository is when choosing the type of submission for your repository.

To promote your project and make it more discoverable to other students, you should assign one or more topics and GitHub Student Developer Pack offers to your repository. For more information, see "Classifying your repository with topics."

Once a repository has been submitted to GitHub Community Exchange, it will be published immediately with the purpose, topics, and offers you've chosen. The GitHub Community Exchange community moderates all repository submissions.

Submission requirements

Your repository must meet a minimum set of requirements for a submission to be accepted. During the submission process, if the submission criteria hasn't been met for your selected repository, you will be notified of the missing items.

For a submission with a purpose of Learn, your repository must have:

  • A description.
  • A LEARN.md file to provide step-by-step instructions, with text and/or media, on how you built your project. Ideally, your LEARN.md file will deconstruct your project into small components and provide thorough details of each step, so that other students can code their project by following your instructions.
  • A README.md file to provide a detailed description of your project.
  • A License so others are aware of what they can and cannot do with your source code.

For a submission with a purpose of Collaborate, your repository must have:

  • A description.
  • A README.md file to provide a detailed description of your project.
  • A License so others are aware of what they can and cannot do with your source code.
  • One or more issues for collaborators to work on.
  • CONTRIBUTING.md file to communicate how to contribute to your project.

A good repository submission for both Learn and Collaborate purposes, is a repository that follows community standards. For more information, see "About community profiles for public repositories."

Submitting your repository

  1. From your GitHub Education dashboard, navigate to the GitHub Community Exchange home page.
  2. Above the list of repositories, to the right of the search and dropdown filters, click Add repository.
    Screenshot of a row of buttons and dropdown menus. The "Add repository" button is outlined in dark orange.
  3. In the pop-up window, use the What is the purpose of your submission? drop-down menu and select one or more entries matching your submission.
  4. Use the Which repository would you like to use? drop-down menu and select the repository for your submission. If the submission criteria hasn't been met, you will be notified of the missing items, and you can click on Edit your repository if you want to view the repository and make changes to meet the criteria.
  5. Use the Which offers did you use for your project? drop-down menu and select one or more entries matching your submission.
  6. Click Submit the project.