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

Commit 2f4ea1a

Browse files
committed
Add Contributing section
1 parent afa7e9d commit 2f4ea1a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,23 @@ The following are not fully implemented yet.
9898

9999
* `snapshot`
100100

101+
## Contributing
102+
103+
To add a new integration, you'll need to create a new `Service` subclass. Please
104+
use existing services as an example:
105+
106+
- Chat service examples: `hipchat`, `campfire`
107+
- Issue tracker examples: `github_issues`, `lighthouse`
108+
109+
Ensure that you're class implements `#receive_test`. It must handle any
110+
exceptions and always return a hash of `{ ok: true|false, message: "String (HTML
111+
ok)" }`.
112+
113+
When you open your PR, please include an image for your service.
114+
[Example][service_avatar].
115+
116+
[service_avatar]: https://codeclimate.com/assets/integration_icons/campfire-9f0475f77133a3ff5267972436dead60.png
117+
101118
## License
102119

103120
See LICENSE.txt. This incorporates code from bugsnag-notification-plugins and

0 commit comments

Comments
 (0)