Skip to main content

Creating a project

Learn how to create an organization or user project.

Projects are an adaptable collection of items that stay up-to-date with GitHub data. Your projects can track issues, pull requests, and ideas that you note down. You can add custom fields and create views for specific purposes.

Creating a project

Creating an organization project

Organization projects can track issues and pull requests from the organization's repositories.

  1. In the top right corner of GitHub.com, click your profile photo, then click Your organizations. Your organizations in the profile menu

  2. Click the name of your organization. Organization name in list of organizations

  3. Under your organization name, click Projects. Screenshot showing the 'Projects' tab

  4. Click New project. Screenshot showing New project button

  5. When prompted to select a template, click a template or, to start with an empty project, click Table or Board. Then, click Create.

    Screenshot showing template selection modal

Creating a user project

User projects can track issues and pull requests from the repositories owned by your personal account.

  1. In the top right corner of GitHub.com, click your profile photo, then click Your profile. Profile photo

  2. On your profile, click Projects. Screenshot showing the 'Projects' tab

  3. Click New project. New project

  4. When prompted to select a template, click a template or, to start with an empty project, click Table or Board. Then, click Create.

    Screenshot showing template selection modal

Updating your project description and README

You can set your project's description and README to share the purpose of your project, provide instructions on how to use the project, and include any relevant links.

  1. Navigate to your project.
  2. In the top-right, click to open the menu. Screenshot showing the menu icon
  3. In the menu, click Settings to access the project settings. Screenshot showing the 'Settings' menu item
  4. To add a short description to your project, under "Add a description", type your description in the text box and click Save. Screenshot showing the 'Add my description' settings
  5. To update your project's README, under "README", type your content in the text box.
    • You can format your README using Markdown. For more information, see "Basic writing and formatting syntax."
    • To toggle between the text box and a preview of your changes, click or . Screenshot showing editing a project's README
  6. To save changes to your README, click Save. Screenshot showing the 'Save' button for a project's README

You can view and make quick changes to your project description and README by navigating to your project and clicking in the top right.

Further reading