Skip to content
This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit afa7e9d

Browse files
committed
Touch up README
- Add description and overview - Remove events we no longer plan to implement
1 parent 2a3e4f2 commit afa7e9d

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Code Climate Services
22

3+
A collection of classes, each responsible for integrating one external service
4+
with the Code Climate system.
5+
6+
## Overview
7+
8+
Services define `#receive_<event>` methods for any events they are interested
9+
in. These methods will be invoked with `@payload` set to a hash of data about
10+
the event being handled.
11+
12+
The structure of this data is described below. Note that there may be additional
13+
keys not listed here.
14+
315
## Events
416

517
Attributes common to all event types:
@@ -61,6 +73,10 @@ Event-specific attributes:
6173
}
6274
```
6375

76+
*Note*: The reason for the top-level `warning_type` attribute is for when the
77+
list of vulnerabilities are of mixed warning types. In this case, the top-level
78+
attribute can be used in any messaging.
79+
6480
### Pull Request
6581

6682
Event name: `pull_request`
@@ -80,9 +96,7 @@ Event-specific attributes:
8096

8197
The following are not fully implemented yet.
8298

83-
* :issue
84-
* :unit
85-
* :snapshot
99+
* `snapshot`
86100

87101
## License
88102

0 commit comments

Comments
 (0)