Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
slavaleleka committed Jul 24, 2024
1 parent 272376a commit ee0a5a1
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,39 @@ database converted to a simple JSON format with some additions from us.
In addition, there's also a file with companies metadata that we use in
AdGuard VPN.

- [Workflow](#workflow)
- [Naming of branches and commits](#naming-of-branches-and-commits)
- [Assignment of files](#assignment-of-files)
- [How to add new or rewrite whotracks.me data](#how-to-add-new-or-rewrite-whotracksme-data)
- [How to add a new company or overwrite whotracks.me data](#how-to-add-a-new-company-or-overwrite-whotracksme-data)
- [How to add a new tracker or overwrite whotracks.me data](#how-to-add-a-new-tracker-or-overwrite-whotracksme-data)
- [Tracker categories](#tracker-categories)
- [How to build trackers data](#how-to-build-trackers-data)
- [Company icons](#company-icons)
- [Policy](#policy)
- [Acknowledgements](#acknowledgements)

## Workflow

- create a fork of the repository on GitHub.
- create a branch from actual main branch.
- add a tracker.
- create a Pull Request.
- Create a fork of the repository on GitHub.
- Create a branch from the actual main branch.
- Add a tracker.
- Create a Pull Request.

## Naming of branches and commits

- the branch name format:
`fix/issueNumber_domain`

```markdown
fix/34_showrss.info
fix/34_example.info
```

- the commit message format:
`Fix #issueNumber domain`

```markdown
Fix #34 showrss.info
Fix #34 example.info
```

## Assignment of files
Expand Down Expand Up @@ -139,7 +151,7 @@ Add tracker domains to the **trackerDomains** section:
| 13 | email | Includes webmail and email clients |
| 14 | consent | - |
| 15 | telemetry | - |
| 16 | mobile_analytics | Collects and analyzes data related to mobile app usage and performance |
| 101 | mobile_analytics | Collects and analyzes data related to mobile app usage and performance |

## **How to build trackers data**

Expand Down

0 comments on commit ee0a5a1

Please sign in to comment.