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

Commit ea7f94b

Browse files
committed
Documentation improvements
- Link to classes as examples - Link directly to `receive_test` example
1 parent fdf89c3 commit ea7f94b

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,19 @@ The following are not fully implemented yet.
103103
To add a new integration, you'll need to create a new `Service` subclass. Please
104104
use existing services as an example:
105105

106-
- Chat service examples: `hipchat`, `campfire`
107-
- Issue tracker examples: `github_issues`, `lighthouse`
106+
- Chat service examples: [hipchat][], [campfire][]
107+
- Issue tracker examples: [github_issues][], [lighthouse][]
108+
109+
[hipchat]: /codeclimate/codeclimate-services/blob/master/lib/cc/services/hipchat.rb
110+
[campfire]: /codeclimate/codeclimate-services/blob/master/lib/cc/services/campfire.rb
111+
[github_issues]: /codeclimate/codeclimate-services/blob/master/lib/cc/services/github_issues.rb
112+
[lighthouse]: /codeclimate/codeclimate-services/blob/master/lib/cc/services/lighthouse.rb
108113

109114
Ensure that your class implements `#receive_test`. It must handle any exceptions
110115
and always return a hash of `{ ok: true|false, message: "String (HTML ok)" }`.
116+
[Example][test_example].
117+
118+
[test_example]: /codeclimate/codeclimate-services/blob/master/lib/cc/services/jira.rb#L31
111119

112120
When you open your PR, please include an image for your service.
113121
[Example][service_avatar].

0 commit comments

Comments
 (0)