Commit 5be4e66a authored by Laura Kalbag's avatar Laura Kalbag

Update readme with better instructions for contributions and updated...

Update readme with better instructions for contributions and updated instructions. Towards #293. Closes #294
parent ce568597
......@@ -207,25 +207,70 @@ Currently, you need to have commit rights to the Content repository to use the B
## Find who owns and runs the tracker
1. Start by editing the tracker: `better/edit drafts/trackers/somedoma.in`. This will create an issue in GitLab (or update an existing issue, if one already exists) and create or checkout a branch for you. It will also open your working copy of the tracker page in your system editor and in the browser.
1. Start by editing the tracker: `better/edit drafts/trackers/somedoma.in`.
*This will create an issue in GitLab (or update an existing issue, if one already exists) and create or checkout a branch for you. It will also open your working copy of the tracker page in your system editor and in the browser.*
2. First, enter the domain into your browser in a private window to see if it loads.
3. If it doesn’t load, or if you get a blank page, perform a whois. We are currently using http://whois.domaintools.com for these so we can link to is as a source when stating ownership information. However, you will sometimes get more information from a direct whois look-up on your machine. In Terminal: `whois somedoma.in`
*Make sure you don’t have an VPNs or extensions blocking or making your browser behave differently from the norm. If you have any tracker blockers already enabled, it may make it harder to investigate!*
3. If it doesn’t load, or if you get a blank page, perform a whois.
*We are currently using http://whois.domaintools.com for these so we can link to is as a source when stating ownership information. However, you will sometimes get more information from a direct whois look-up on your machine. In Terminal: `whois somedoma.in`*
4. Some trackers use a domain proxy or a cloaking service (e.g., Domains by Proxy) to further hide their origins. In this case, open up the source of some sites that the tracker originated on in the Web Developer console (Timeline view) of Safari (or in the web inspector of your browser of choice) and try to recreate the original call. That might give you more clues about its origin. (To find which sites a tracker is on, perform a search on the *~/better.fyi/drafts/trackers folder*. For example, you can open up the folder in Sublime Text and do a global search for the tracker name.)
4. Some trackers use a domain proxy or a cloaking service (e.g., Domains by Proxy) to further hide their origins. In this case:
* Open up the source of a site that the tracker originated on in the Web Developer console (Timeline view) of Safari (or in the web inspector of your browser of choice)
* Try to recreate the original call. This might give you more clues about its origin.
*(To find which sites a tracker is on, perform a search on the ~/better.fyi/drafts/trackers folder. For example, you can open up the folder in your text editor and do a global search for the tracker name.)*
Other useful tools:
* [Wikipedia](wikipedia.org)
* [Mozilla Lightbeam](https://www.mozilla.org/en-US/lightbeam/)
## Add the tracker/site name to the tracker markdown file
* The name should be formatted as:
```markdown
**TrackerName** by Corporation (domain.tld)
```
* If the tracker name is the same as the corporation name *(e.g. Adlucent by Adlucent)* then just keep the tracker name, and don’t incude the corporation name.
*When you edit a tracker markdown file for the first time, the domain.tld will already be in the title.*
## Add the site description
1. Add a concise one-line description of what the tracker, or the tracker owner, does.
* Add a concise one-line description of what the tracker, or the tracker owner, does.
*Usually the tracker sites have vague marketing spiel to describe themselves. Often a clearer description can be found in their privacy policy. If you can’t find a concise description in their own words, try to find their entry on [Wikipedia](https://wikipedia.org), Bloomberg or Crunchbase.*
Other useful tools:
* [Wikipedia](wikipedia.org)
## Include references in Notes
* Whether it’s the domain whois, or where you found the site description, include a link back to every source in the Notes section.
* Include a link to the tracker/corporation Privacy Policy (if it exists!)
* If you end up looking through the source file to find more information, you can include relevant code snippets in markdown.
*You can use sub-lists in Notes by using indented lists in markdown.*
*[See the Demandbase tracker for an varied use of Notes](https://better.fyi/trackers/company-target.com/#notes)*
# Handling duplicate trackers
* Loads of trackers have multiple domains for the same tracker, or group of trackers. In this case, we don’t want duplicate entries that don’t stay in sync.
1. The first tracker found and investigated is the canonical tracker.
2. Any further trackers with the same name/owner should link to the canonical tracker in place of the description. *Example from [addthisedge.com tracker](https://better.fyi/trackers/addthisedge.com/):*
```markdown
> See [addthis.com](/trackers/addthis.com/).
```
3. The Ethical Design Violations are still necessary, as the type of violation might vary between the domains.
4. The Block Rule is still necessary, as it blocks this specific domain.
5. The only Notes necessary is the source for the domain origin. Any other notes can be added to the canonical tracker.
# Content authoring guidelines
* Be brief: do not quote the whole privacy policy; pick out interesting bits.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment