Skip to content

Reporting

Ioannis Canellos edited this page Jun 23, 2020 · 2 revisions

The goal was to have a reporting system that would be following the:

  • K.I.S.S. (Keep it simple stupid)
  • D.R.Y. (Don't repeat yourself)

In that spirit, each issue should be created once and only once directly on the project where the work is taking place (upstream), or in JIRA if its something related to productization. For everything else (e.g. conferences, blogs, community engagement etc) we could have a single GitHub project acting as a host (nowadays its called snowdrop/team).

Reporting

To generate the report, we use the snowdrop-bot. The bot is responsible for collecting:

  • Github Issues
  • Pull requests (Pull requests not linked to issues are still expected to work)
  • JIRA tickets

Dashboard

For planning and visualizing things like weekly plan, backlog and in progress work, we use Zenhub.To be able to visualize 3d party projects like (quarkus, odo, kubernetes-client, spring-cloud-kubernetes etc) which are projects that we don't have admin access we fork them under snowdrop-zen organization and have the bot copy issues assigned to our team members from upstream. Note that this process of bridging is only needed for the dashboard and it's not directly related to reporting (meaning that the bot is meant to work upstream and doesn't require a fork). Even though it was not originally intended, there were cases of issues opened directly in the forked repository instead of upstream. I feel that this should be best avoided as it forces us dragging the snowdrop-zen into reporting and possibly causing issues with duplicates etc. We should preferably use the upstream repository.

So where do I log my work?

  • Pull requests: Nowhere. Pull requests should be picked up automatically from upstream.- Upstream task: Just create the issue upstream and assign it to you. If you can't assign it yourself ask the issue to be assigned to you so that it can be picked up by the bot.- Private issue: For private issues, productization related etc, we already have JIRA let's stick to it.- Non development task: Conferences, Talks, Blogs, Discussions or anything that takes up time and doesn't fit the categories above: snowdrop/team.
Clone this wiki locally