Skip to content
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
1. [Versioning](./eiffel-syntax-and-usage/versioning.md)
1. [Compositions and Validity Checking](./eiffel-syntax-and-usage/compositions-and-validity-checking.md)
1. [Security](./eiffel-syntax-and-usage/security.md)
1. [Event Categories](./eiffel-syntax-and-usage/event-categories.md)
1. The Eiffel Vocabulary
1. [EiffelActivityTriggeredEvent (ActT)](./eiffel-vocabulary/EiffelActivityTriggeredEvent.md)
1. [EiffelActivityCanceledEvent (ActC)](./eiffel-vocabulary/EiffelActivityCanceledEvent.md)
Expand Down
47 changes: 47 additions & 0 deletions eiffel-syntax-and-usage/event-categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Event Categories

The Eiffel protocol specifies each event on its own. For convenience reasons the
protocol also provides a description on how to group them together in
categories. Use the following categories to group events together for ease of
talking about them or in reasoning. To make pictures with Eiffel events
consistent throughout the documentation we have assigned each category a color
picked from the
[Unicode's full list of geometric emojis](https://unicode.org/emoji/charts/full-emoji-list.html#geometric).

| Category | Color |
|:-------------|:-----:|
| Activity | 🔵 |
| Artifact | 🔴 |
| Definition | 🟣 |
| Notification | 🟠 |
| Source | 🟢 |
| Test | 🟡 |
| Verdict | 🟤 |

The events and their categories.

| Category | Name | Abbreviation | Color |
|:-------------|:---------------------------------------------------------------------------------------------------------------------------|:------------:|:-----:|
| Activity | [EiffelActivityCanceledEvent](../eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | 🔵 |
| Activity | [EiffelActivityFinishedEvent](../eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | 🔵 |
| Activity | [EiffelActivityStartedEvent](../eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | 🔵 |
| Activity | [EiffelActivityTriggeredEvent](../eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | 🔵 |
| Artifact | [EiffelArtifactCreatedEvent](../eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 |
| Artifact | [EiffelArtifactPublishedEvent](../eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 |
| Artifact | [EiffelArtifactReusedEvent](../eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 |
| Definition | [EiffelFlowContextDefinedEvent](../eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 |
| Definition | [EiffelCompositionDefinedEvent](../eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 |
| Definition | [EiffelEnvironmentDefinedEvent](../eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 |
| Definition | [EiffelIssueDefinedEvent](../eiffel-vocabulary/EiffelIssueDefinedEvent.md) | ID | 🟣 |
| Notification | [EiffelAnnouncementPublishedEvent](../eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 |
| Source | [EiffelSourceChangeCreatedEvent](../eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 |
| Source | [EiffelSourceChangeSubmittedEvent](../eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 |
| Test | [EiffelTestCaseCanceledEvent](../eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 |
| Test | [EiffelTestCaseFinishedEvent](../eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | 🟡 |
| Test | [EiffelTestCaseStartedEvent](../eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | 🟡 |
| Test | [EiffelTestCaseTriggeredEvent](../eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | 🟡 |
| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](../eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | 🟡 |
| Test | [EiffelTestSuiteFinishedEvent](../eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 |
| Test | [EiffelTestSuiteStartedEvent](../eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 |
| Verdict | [EiffelConfidenceLevelModifiedEvent](../eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 |
| Verdict | [EiffelIssueVerifiedEvent](../eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | 🟤 |
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ basepython = python3

[testenv:black]
deps =
black==22.6.0
black==22.6.0

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No big deal, but you're adding a blank line and changing the indentation of line 31.

commands = black --check --diff .

[testenv:flake8]
Expand Down