Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Latest commit

 

History

History
95 lines (61 loc) · 4.83 KB

CONTRIBUTING.md

File metadata and controls

95 lines (61 loc) · 4.83 KB

Contributing to Everyday Privacy

First off, thank you for considering contributing to Everyday Privacy. It's people like you that make Everyday Privacy such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Everyday Privacy is an open source project and we apperiacte all the help and support we can get from the community. There are multiple ways of contributing, from correcting/updating information, adding more services, improving the code structure, submitting bug reports, feature requests or reading through new services privacy policies.

Please, don't use the issue tracker for support questions. Check whether the documentation for Jekyll. If your problem is not strictly Jekyll or Jekyll related, you can email me directly tim@harek.dev. Stack Overflow is also worth considering.

Ground Rules

Be respectful, considerate of other!

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes, pages or styling to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.

Your First Contribution

Unsure where to begin contributing to Everyday Privacy? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.
  • Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Getting started

General guidelines

For something that is bigger than a one or two line fix:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. Submit a Pull Request and specify what you have changed, fixed or added.

Small or "obvious" fixes

Small contributions are considired as the following;

  • Spelling / grammar fixes
  • Typo corrections, white space and formatting changes
  • Changes to Gemfile _config.yml
  • Moving source files from one directory to another

Adding a service

If you want to add a service via a Pull Request (PR) please consider the following;

  1. Use _services/facebook.md as a template
  2. Include an SVG version of the service's logo
  3. Read through the service's privacy policy carefully
    • Include either a direct link to the section referring to or an excerpt a bullet in your submission in a collapsable in the PR.
  4. Describe why you think it's important to include this service.
Example PR

Facebook

Link to their privacy policy

Information in the camera viewport

It can also include what you see through features we provide, such as our camera, so we can do things like suggest masks and filters that you might like, or give you tips on using portrait mode.

Information in the camera viewport

It can also include what you see through features we provide, such as our camera, so we can do things like suggest masks and filters that you might like, or give you tips on using portrait mode.

Why

This service is used by used by 2.85 billion people every month

How to report a bug

Please select Bug report when you open a issue and answer the question in the template.

How to suggest a feature or enhancement

The goal of the project is to help educate people about what kind of data various services are collecting, and how people can increase their accounts security and privacy. It's supposed to be easy to learn about each service without any prior technical knowledge.

If you find yourself wishing for a feature that doesn't exist in Everyday Privacy, you are probably not alone. There are bound to be others out there with similar needs. Open an issue and select New feature and answer the questions in the template to the best of your ability.

Code review process

Explain how a contribution gets accepted after it’s been submitted.

Tim Hårek, the creator, will review each contribution as the project stands of 2021-06-11.

Tim looks at Pull Requests on a regular basis, you can expect to get a response within the same week. After two weeks the pull request may be closed if it's inactive.