Tools For Better Developers

Meta: GitHub Workflow

2021 ∙ August ∙ Meta

2 years ago ∙ 1 minute read

This article describes how we use GitHub issues and projects, both for new development and for support.

Workflow

  1. Open an issue in the most relevant repository. See all the issues you created in Account -> Issues -> Created. See all the issues by applying a filter in Account -> Issues.

  2. Communicate in order to fully understand the issue and reproduce it. Try resolving it right now. If you decide to resolve it later, assign a project, otherwise, close the issue. In any case, assign a label. See all the issues without a project assigned by applying a filter in Account -> Issues.

  3. Review "To do" issues in projects. Prioritize them, move them to additional columns, or even stash them in additional projects. Fix bugs before implementing new features.

  4. Work on issues. Move them to "In progress" column, assign them to yourself, and assign a milestone. Use a label to communicate that the issue resolution is "waiting" for an external action. See all assigned issues in Account -> Issues -> Assigned.

  5. Close issues. Un-assign yourself. After releasing a milestone, archive the completed issues in projects.

GitHub Projects

  • Osm Framework - Osm Framework development and support. Also, the default destination for all accepted issues.
  • osm.software Blog - blog post ideas.
  • Admin /API Sample App - an experimental project that allows quick creating of the Admin UI and the HTTP API.