Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 6 terms types, also known as and legal references format #62

Merged
merged 16 commits into from
Aug 12, 2024
Merged
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

All changes that impact users of this module are documented in this file, in the [Common Changelog](https://common-changelog.org) format with some additional specifications defined in the [CONTRIBUTING](./CONTRIBUTING.md) file. This codebase adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased [minor]

> Development of this release was supported by the [NGI0 Entrust Fund](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl/) with financial support from the European Commission's [Next Generation Internet](https://www.ngi.eu) programme, under the aegis of DG CNECT under grant agreement N°101069594. [Learn more](https://nlnet.nl/project/TOSDR-OTA/) on the NLNet website.

### Added

- Add `Accessibility Statement` ([discussions/36](https://github.com/OpenTermsArchive/terms-types/discussions/36))
- Add `Affiliate Agreement` ([discussions/41](https://github.com/OpenTermsArchive/terms-types/discussions/41))
- Add `Anti-corruption Policy` ([discussions/39](https://github.com/OpenTermsArchive/terms-types/discussions/39))
- Add `Editorial Policy` ([discussions/35](https://github.com/OpenTermsArchive/terms-types/discussions/35))
- Add `Hyperlinks Policy` ([discussions/43](https://github.com/OpenTermsArchive/terms-types/discussions/43))
- Add `Whistleblower Policy` ([discussions/37](https://github.com/OpenTermsArchive/terms-types/discussions/37))
- Add `also known as` property for synonyms
- Add leading jurisdiction emoji for legal references
- Add legal references and `also known as` data

## 1.2.1 - 2024-08-12

_Full changeset and discussions: [#61](https://github.com/OpenTermsArchive/terms-types/pull/61)._
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Provide at least the terms you intend to track as example of the new terms type,

Include any relevant [references](./README.md#references) that may help in understanding the purpose of this type. This could include legal definitions, discussions, or any other resource that provides context or background information.

References will then be listed in the type definition, with their URL and a title describing the content and source.

### Build consensus

Publicise your suggestion across Open Terms Archive channels and engage the community. Throughout the discussion, the name and the triptych should be challenged, taking into account international perspectives on phrasings and the variety of definitions across jurisdictions.
Expand All @@ -57,7 +59,7 @@ Once:
- a consensus has been reached on the name;
- at least 2 weeks have elapsed since the opening of the discussion, to ensure visibility throughout the community.

Then the Open Terms Archive Core Team will review and validate the suggestion, considering factors like uniqueness, clarity, and relevance. If validated, the discussion will be turned into a pull request for addition into the database.
Then the Open Terms Archive Core Team will review and validate the suggestion, considering factors like uniqueness, clarity, and relevance. If validated, the discussion will be turned into a pull request for addition into the database. To ease tracking and participation, each pull request will contain only one type addition, and will link to the discussion.

## Governance considerations

Expand Down
46 changes: 35 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ The name of each type is written with title capitalisation (every noun is capita

It should be the most commonly used and most internationally understandable for this type.

#### Use singular

For consistency, the term “Policy” in a type name should only be used singular (“policy”), never plural (“policies”). Similarly, all terms types should have a singular name.

### Alternative names

Some terms types might have several commonly-used names, often varying by jurisdiction. To increase discoverability and clarity, alternative names can be provided to terms types. These alternative names are not translations, but rather synonyms in English. They are provided in an array under the `also known as` key.

Examples:

- `"Hyperlinks Policy" : { "also known as": [ "Links Policy", "Linking Policy" ], … }`
- `"Whistleblower Policy": { "also known as": [ "Whistleblower Protections" ], … }`

### Triptych

In order to guide usage and disambiguate synonyms, each terms type is characterised by a triptych along the three dimensions of the `commitment` that is being taken in it:
Expand Down Expand Up @@ -71,21 +84,32 @@ It may also contain an optional `references` property which contains a map of re
}
```

#### Legal references

Legal references will be prefixed by the flag emoji of the jurisdiction of enactment, will use the full name of the law, and will link to the official journal URL.

Examples:

- `"🇬🇧 Bribery Act 2010": "https://www.legislation.gov.uk/ukpga/2010/23/contents"`
- `"🇫🇷 Loi n°2005-102 du 11 février 2005 pour l'égalité des droits et des chances, la participation et la citoyenneté des personnes handicapées, article 47": "https://www.legifrance.gouv.fr/jorf/article_jo/JORFARTI000001290363"`

### Example

```json
{
"Business Mediation Policy": {
"commitment": {
"writer": "intermediation service provider",
"audience": "business users",
"object": "mediation process after internal complaints handling failed"
},
"references": {
"Open Terms Archive discussion": "https://github.com/OpenTermsArchive/engine/discussions/933",
"P2B Regulation 2019/1150, Article 12": "https://eur-lex.europa.eu/eli/reg/2019/1150/oj#d1e1148-57-1"
}
"Whistleblower Policy": {
"also known as": [
"Whistleblower Protections"
],
"commitment": {
"writer": "service provider",
"audience": "employees",
"object": "reporting on suspected misconduct and illegal acts and prevention of retaliation"
},
"references": {
"Open Terms Archive discussion": "https://github.com/OpenTermsArchive/terms-types/discussions/37",
"🇺🇸 Whistleblower Protection Act of 1989": "https://www.govinfo.gov/content/pkg/STATUTE-103/pdf/STATUTE-103-Pg16.pdf",
"🇫🇷 Loi n°2016-1691 du 9 décembre 2016 relative à la transparence, à la lutte contre la corruption et à la modernisation de la vie économique, dite « Sapin II »": "https://www.legifrance.gouv.fr/loda/id/JORFTEXT000033558528"
}
}
```

Expand Down
Loading