You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/contributing-terms.en.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,12 @@ This is a step by step guide to help you add declarations to the [Contrib collec
9
9
10
10
Having understood briefly how a declaration is structured in JSON format, we need to look at concrete steps on how you can add these JSON files to the repository.
11
11
12
+
## Tracking new terms
13
+
14
+
Tracking terms is done by _declaring_ them and the service they are associated with in a collection. Declarations are found in JSON files in the `declarations` folder of the collection.
15
+
16
+
Before adding new terms, open the [`declarations`](https://github.com/OpenTermsArchive/contrib-declarations/tree/main/declarations) folder and check if the service you want to track terms for is already declared. If a JSON file with the name of the service is already present, you can jump straight to [declaring terms](#declaring-terms). Otherwise, keep reading!
17
+
12
18
## Prerequisites
13
19
14
20
In order to add declarations:
@@ -23,7 +29,7 @@ To add a declaration, you need to follow these steps:
23
29
1. Clone the [`contrib-declarations`](https://github.com/OpenTermsArchive/contrib-declarations) repository to your local machine.
24
30
2. Create a branch that describes your contribution e.g. `add_open_terms_archive_terms_of_service` or `add_firefox_privacy_policy`
25
31
3. Run `npm install`. This will install all the dependencies including the Open Terms Archive engine which will allow you to test and validate your declaration.
26
-
4. Create a JSON file with, as filename, the service ID of the service you are adding the declaration for. This JSON file should be in the `declarations` folder of the repository. To learn more about selecting the right service ID, please read the [declaring a new service]({{< relref "reference/declaration#declaring-a-new-service" >}}) section.
32
+
4. Create a JSON file with, as filename, the [service ID]({{< relref "reference/declaration#service-id" >}}) of the service you are adding the declaration for. This JSON file should be in the `declarations` folder of the repository. To learn more about selecting the right service ID, please read the [declaring a new service]({{< relref "reference/declaration#declaring-a-new-service" >}}) section.
27
33
5. Visit the declaration URL and use [browser developer tools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/What_are_browser_developer_tools) to inspect the page and find the right selectors for the significant section containing the terms you want to declare and parts to remove.
28
34
6. After you've properly chosen your selectors and structured your JSON file, you should test and validate your JSON file. To do this, you need to run `npx ota validate --services [service name]` from the root of the repository. This will run a validation on the declaration, highlighting any changes required.
29
35
7. If all tests pass, open a pull request to the main repository.
0 commit comments