-
Notifications
You must be signed in to change notification settings - Fork 61
Add event categories #297
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
m-linner-ericsson
merged 10 commits into
eiffel-community:master
from
m-linner-ericsson:add_event_categories
Oct 11, 2022
Merged
Add event categories #297
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e3a8a36
First idea of event categories
m-linner-ericsson fd7597e
Step version of Black
m-linner-ericsson 76999f2
Add intro and give each category a color
m-linner-ericsson 1f5653c
Reduce the amount of categories and add link in main README.md
m-linner-ericsson 82f5d69
Change colors to improve listing readability
m-linner-ericsson eba9514
Fix abbreviation of IssueDefined
m-linner-ericsson 7004091
Fixes after review
m-linner-ericsson 018db12
Merge branch 'master' into add_event_categories
m-linner-ericsson ac29d08
Merge branch 'master' into add_event_categories
m-linner-ericsson fc7fda3
Update tox.ini
m-linner-ericsson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | 🟤 | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.