Skip to content

Latest commit

 

History

History
101 lines (85 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

101 lines (85 loc) · 3.63 KB
Raw

Adding a service to the GDPR Tracker database

We use Github Flow, so all code changes happen through pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  • Fork the repo and create your branch with the name of the service you want to add from master.
  • Add a file with the service name to the data folder.
  • Make sure your data follows the following schema. Please look into the following example for more info
  • If you're unsure about certain data points leave them out or check with the company offering the service.
  • Use signed commits. We enforce signed commits to verify the identity of contributors.
  • Ensure the test suite passes.
  • Issue that pull request!

Example

{
  "id": "acme",
  "name": "Acme",
  "description": "CRM & Customer platform for SMBs",
  "categories": [
    "CRM", 
    "Customer Support"
  ],
  "iconUrl": "https://pbs.twimg.com/profile_images/922908923207839744/5EZID3tH_400x400.jpg",
  "website": "https://www.acmesaas.com",
  "applicationUrl": "https://app.acmesaas.com",    
  "twitter": "acme",
  "countryHQ": "US",
  "gdprReadyStatus": "inProgress",
  "privacyUrl": "https://www.acmesaas.com/privacy",
  "dsarUrl": "https://bs.gdprform.io",
  "dpaUrl": "https://www.acmesaas.com/dpa",
  "subprocessorsUrl": "https://www.acmesaas.com/subprocessors",
  "dataCenters": [
    "EU"
  ],
  "hostingPartners": [
    "AWS", 
    "Digital Ocean"
  ],
  "contacts": [
    {
      "type": "DPO",
      "name": "John Doe",
      "email": "[email protected]",
      "region": "EU"
    }, 
    {
      "type": "DPO",
      "name": "Tim Doe",
      "email": "[email protected]",
      "region": "US"
    }
  ],
  "certifications": [
    "ISO 27001", 
    "HIPAA"
  ],
  "dataBreaches": [
    {
      "date": "10/12/2017",
      "url": "https://www.beatswtich.com/breach"
    }
  ],
  "articles": [
    {
      "date": "02/12/2018",
      "url": "https://www.beatswtich.com/gdpr"
    }
  ],
  "bugBountyProgramUrl": "https://www.beatswtich.com/bounty-program",
  "statusUrl": "https://www.beatswtich.com/status",
  "statusTwitter": "beatswitchstatus",
  "verified": true
}

Don’t use Github?

If you're not able to add a service Github through you can use the following form to add a service.

We Develop with Github

We use github to host our data, code, to track issues and feature requests, as well as accept pull requests.

Any contributions you make will be under the MIT License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under the MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.