Skip to content

All.issue workflow.explanation

TODO(Grisha): consider merging the current doc with /docs/work_organization/all.use_github.how_to_guide.md into something like "ck.planning.how_to_guide.md".

Issue workflow#

Idea -> Project -> Task (Issue)

Idea#

An idea is often the starting point for new initiatives and can be abstract and unstructured.

Examples:

  • "What if we expand our current trading universe?"
  • "It would be nice to get historical bid/ask data"

We use Google Docs (Gdocs) to keep track of ideas.

Example flow:

  • You have an idea and you do not have time to think it through/execute at the moment
  • However, you would like to keep track of what could be done in the future
  • You put a note in a Gdoc for your future self
  • Use suggestion mode so that other people can track that (once in a while we accept all the changes)

This is helpful because:

  • We keep track of work that could be done
  • Simplifies the planning
    • E.g., if someone is blocked, he/she can go to a Gdoc and choose a project
  • People are notified of that change and see the text in suggestion mode
  • It is quick to edit a Gdoc and has low friction
  • Since an idea is abstract and unstructured it is easier to edit it later in a Gdoc rather than in a GitHub issue

Project#

Unlike ideas, projects have clear goals, defined scope, tangible outcomes and time constraints.

We use GitHub Projects to track projects /docs/work_organization/all.use_github.how_to_guide.md#projects.

To go from "idea" to "project" one needs to perform a through analysis:

  • Identify a problem
  • Suggest solutions for the problem
  • Split the work into actionable tasks
  • Estimate the complexity

Team leaders are responsible for converting "ideas" into "projects". The outcome of the analysis is a GitHub Project with clear objectives, start/end dates, assignees and filed GitHub issues.

Task (Issue)#

A task is a specific, actionable item that needs to be completed, often as part of a project. Tasks are usually smaller in scope and more focused on single activities or steps within a project.

We use GitHub Issues to track tasks. Every issue should belong to a GH Project /docs/work_organization/all.use_github.how_to_guide.md#issue.

Last review: GP on 2024-05-25