Skip to content

Commit

Permalink
Improve readability of the local contrib guide
Browse files Browse the repository at this point in the history
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
  • Loading branch information
Cli4d and MattiSG authored Sep 1, 2023
1 parent d82d01e commit 6a50e95
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/contributing-terms.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6a50e95

Please sign in to comment.