Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 733 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 733 Bytes

Contributing

When adding a new endpoint

-- | The title, as in the GitHub API docs.
-- <url to the docs>
endpointR :: Request k EndpointResult
endpointR = query ["endpoint"] []

For example:

-- | Get your current rate limit status.
-- <https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status>
rateLimitR :: Request k RateLimit
rateLimitR = query ["rate_limit"] []

Also re-export endpoints from the top GitHub module. Note: only R variants, not IO.

Miscellaneous

  • Don't edit CHANGELOG.md, it will only conflict.
  • Don't edit package version.
  • The codebase is not uniform in style, don't make it worse.