From fd962f6ccce1cf76371bf581745e3262d2ad1310 Mon Sep 17 00:00:00 2001 From: Billy Lynch Date: Thu, 1 Aug 2013 12:32:34 -0400 Subject: [PATCH] Updated CONTRIBUTING.md to describe new naming scheme. --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e429bd..2216db7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,4 +74,9 @@ broken into separate service objects. These services map directly to how the [GitHub API documentation][] is organized, so use that as your guide for where to put new methods. +Sub-service (e.g. [Repo Hooks][]) implementations are split into separate files +based on the APIs they provide. These files are named service_api.go (e.g. +repos_hooks.go) to describe the API to service mappings. + [GitHub API documentation]: http://developer.github.com/v3/ +[Repo Hooks]: http://developer.github.com/v3/repos/hooks/