Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 4.9 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 4.9 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-deletion page. If no such page exists, the url should be a contact or help page explaining the process of account deletion.
  • url_CODE: (optional) Use the language CODE as suffix of the url field to provide language-specific deletion codes, shown on the respective language page.
  • difficulty: This is an indicator used on the site to determine the difficulty of account deletion. Use one of:
    • easy: Sites with a simple process such as a 'delete account' button
    • medium: Sites that do allow account deletion 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 deletion
    • limited: Sites that only allow you to delete your account if you live in an area with privacy rights. This is only used for websites that require proof that you are covered by local law and verify it.
    • impossible: For sites where it's basically impossible to totally delete your account, even if you contact them
  • notes: (optional) Notes will be shown when someone hovers on that service. Notes may include additional information you might need to delete your account (e.g. Skype) or consequences of deleting your account (e.g. iTunes). If you are drastically changing existing notes, do delete its translations, unless you have proficiency in one or more of them. If you want to include links in the notes, you should use markdown syntax, e.g.: Visit [this page](https://example.com). would become "Visit this page."
  • 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 cancel your account, 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 Deletion Request".
  • email_body: (optional) Set the body for the email link. If unset, the default text is "Please delete my account, my username is XXXXXX".
  • domains: This is used by the Unofficial Chrome extension and Firefox Add-on

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 deletion, 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

There are two options if you want to help on the translation of the site, via Crowdin or directly on the repository. Crowdin is preferred as it is more user friendly.

Modify an existing Translation

Via Crowdin: just click on the language and browse the strings with missing translations.

Via repository: Look for the CODE.json file in the _data/trans/ directory where CODE is your short country code and then translate it there. You can read translation reference to see what each of the keys is describing or translating.

Add a new translation

Via Crowdin

Open an issue to request a new language to be added, then refer to the Modify an existing translation section.

Via Repository

  1. Create a new CODE.json file in the _data/trans/ directory where CODE is a language tags as described by the IETF in BCP47.
    Typically, using the shortest available ISO 639 code is sufficient. Appending an ISO 3166-1 alpha-2 country code using a hyphen to distinguish the region is possible, if necessary. (e.g. cs for Czech or pt-PT for portuguese as spoken in Portugal)
  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.