Skip to content
This repository has been archived by the owner on Dec 29, 2020. It is now read-only.

Latest commit

 

History

History
26 lines (18 loc) · 976 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 976 Bytes

Contributing

Adding a service

You can add a service by adding a new entry to the services.yml data file.

Make sure to include the following keys:

  • name - Name of the service.
  • description - A few-word description of the service.
  • url - URL of the main page of the service.
  • review_url - URL of the page on which permissions can be managed.

Optionally, include a link (using the key docs_url) to service's own documentation regarding third-party app permissions.

See, for example, GitHub's entry:

- name: GitHub
  description: Hosting service for software development.
  url: https://github.com/
  review_url: https://github.com/settings/applications
  docs_url: https://help.github.com/articles/connecting-with-third-party-applications

If possible, include a square icon of the service in the images/ folder of which the file name should equal the name of the service down-cased (e.g. github.png for GitHub).