Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

46 lines (36 loc) · 3.69 KB
Raw

Contributing

The sites, urls and additional notes are stored in _data/sites.json. If you want to add a site to the list you'll need the following information:

  • name: The name of the service.
  • url: The url of the account data request page. If no such page exists, the url should be a contact or help page explaining the process for requesting account data.
  • url_CODE: (optional) Use the language CODE as suffix of the url field to provide language-specific data request codes, shown on the respective language page.
  • difficulty: This is an indicator used on the site to determine the difficulty of requesting account data. Use one of:
    • easy: Sites with a simple process such as a 'download account' button
    • medium: Sites that do allow account data requests but require you to perform additional steps
    • hard: Sites that require you to contact customer services or those that don't allow automatic or easy account data requests
    • limited: Sites that require you to verify that you live in an area with privacy laws before accessing your data
    • impossible: For sites where it's basically impossible to totally request your account data, even if you contact them
  • notes: Notes will be shown when someone hovers on that service. Notes may include additional information you might need to request your account data or consequences of requesting your account data.
  • notes_CODE: (optional) Use the language CODE as suffix of the notes field to provide language-specific instructions, shown on the respective language page.
  • email: (optional) If you have to send an email to a company to request your account data, add the email address here. We'll do the rest.
  • email_subject: (optional) Set the subject for the email link. If unset, the default text is "Account Data Request".
  • email_body: (optional) Set the body for the email link. If unset, the default text is "Please send me my account data. My username is XXXXXX".

Contribution checklist

  1. Have you updated to the latest version of the project? git pull
  2. If you have modified an existing service's difficulty, please explain why/give sources.
  3. URLs must be direct links to either account data request, or if this is not available, a relevant help article.
  4. Any steps for the process should be detailed in the notes (if necessary).
  5. Be sure to indent 4 spaces per level.
  6. Be sure to place your entry ALPHABETICALLY in the current list.
  7. Please test that your changes work validating sites.json with something like JSON Lint or the included "validate_json.rb" script

Translation

If you want to help on the translation of the site, you can read translation reference to see what each of the keys is describing or translating.

Modify an existing Translation

Look for the CODE.json file in the _data/trans/ directory where CODE is your short country code

Add a new translation

  1. Create a new CODE.json file in the _data/trans/ directory where CODE is your short country code
  2. Copy the contents of en.json to your new file
  3. Translate each line
  4. Within the _pages/ directory, copy _pages/index.html to a new CODE.html file, and update the lang: CODE line to match the new page's code
  5. Visit gosquared/flags and get the shiny 16px and 24px flags for your language.
  6. Save the flag icons onto assets/icons as CODE16.png and CODE24.png, where CODE is your short country code.
  7. On assets/css/style.css insert a dropdown and a background-image that reference these flags.