From 6a50e95e1fb0cc8ca2fd4c2ae9e64203f3fdae7b Mon Sep 17 00:00:00 2001 From: Clifford Ouma Date: Fri, 1 Sep 2023 11:49:33 +0300 Subject: [PATCH] Improve readability of the local contrib guide Co-authored-by: Matti Schneider --- content/contributing-terms.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/contributing-terms.en.md b/content/contributing-terms.en.md index b165ef86..61934762 100644 --- a/content/contributing-terms.en.md +++ b/content/contributing-terms.en.md @@ -398,7 +398,7 @@ Having understood briefly how a declaration is structured in JSON format, we nee 1. Clone the [contrib-declaration](https://github.com/OpenTermsArchive/contrib-declarations) repository to your local machine. 2. Create a branch that describes your contribution e.g. `add-Open-Terms-Archive-ToS` or `add-firefox-privacy-policy` 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. -4. Create a JSON file with the name 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 name, please read the [declaring a new service](#declaring-a-new-service) section of our docs. +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](#declaring-a-new-service) section. 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. 6. After you've properly added your selectors and structured your JSON file, you need to test and validate your JSON file to make sure it is ok. 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. 7. If all tests are good, make a pull request to the main repository.