API Issue Management With Github

by Kin Lane on 09/23/2012

Github should be the center of your API operations, with the most obvious use being for SDK repositories, but Github offers a lot of other valuable tools that you can use to help manage your API platform.

One great use of Github is as an API issue management tool. The Github issue management system allows you to easily accept issue reports from your API community and apply labels to organize them into appropriate categories.

To setup Github Issue Management for your API, just create a new repository, but you won't actually being pushing any code, you will just be using it as a container for running issue management. Think of it as repository for your API itself.

Once setup, you can link the issue management page directly from your API area, allowing users to actively submit issues, comment and potentialy be part of the API product development cycle.

Along with API Issue Management with Github, you can link issues with the milestones portion of Github, providing deeper roadmap integration, but I will cover that in a separate post.