Notes

You can attach freeform context information to work items like pull requests and issues with notes.

Swarmia supports annotating your work items with notes to provide extra context that might not otherwise be obvious from the data point. For example, you might look at cycle time outlier pull requests, and annotate why the outlier happened.

We will in the UI highlight data points that have notes on them:

This PR has one note on it

Work items with notes are highlighted in scatter plots too

Adding notes from the UI

To add notes, simply click on a pull request or issue anywhere in the app to open its popup:

Adding notes from outside of the UI

It's also possible to add notes from outside of the Swarmia UI. Currently, the only place supported is Github pull requests.

Tag the Github bot with @swarmia <note> and it will be added as a note to that pull request:

You can tag the Swarmia Github bot to easily add notes while you're working on your pull requests

The note becomes visible in the Swarmia UI

Editing notes

Existing notes can be edited or deleted by either:

1. The author of the note

2. Any Swarmia user with the admin role