GitHub Projects

Projects on GitHub are an easy way to organize tasks for a general or specific project/feature.

Getting Started

Click on New project to start with a new project. If you want to see other projects click on pydarn projects for examples of the types of projects.

When selecting a template it is recommended to use Automated Kanban as it will move tasks through the workflow automatically.

Once you create the project several columns will appear that can be edited or renamed; however, it is recommend to keep them as is for consistency. In the To Do column, you can create cards that have tasks to do on this project. These later can be turned into issues by clicking on the ... three dots in the top right corner of the card and selecting convert to issue. Convert cards to issues when you are ready to work on the issue so the issue doesn't get stale.

If an issue and/or pull request is made, you can add the project in the right side column on the issue or pull request page, and it will be placed in the one of the columns of the project.

A useful feature of projects is progress tracking. As cards, issues, and pull requests are opened and closed/merged they will be moved along the columns in the project, which will show up in the progress bar. This is very helpful for specific project boards or features that have a set goal.

General Project

Some projects can be open ended for easy organization for users to focus their attention on tasks. Examples are:

  • Bugs
  • Documentation
  • Best practices

By assigning projects to issues and pull requests, users can organize issues and pull requests by that project. Thus it is helpful for others to assign projects so they can focus on them.

Closing Projects

Once a specific project is done, go to the project page then select the ... three dots to the right of the project and select close.