-
Notifications
You must be signed in to change notification settings - Fork 4
Proposal for Schema Improvements #85
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
Conversation
MattiSG
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this proposal! I think at this stage I have a slight preference for option 1, but let's see how this evolves 🙂
|
What about a new field It could be something like this: or |
|
I support solution B because it offers a data structure optimized for a database rather than one designed to be read as a sentence. This structure is more suitable for coding, as it features clear, distinct fields that facilitate data manipulation and usage in programming contexts. While it may seem appealing to have data fields presented in a sentence format, I believe this approach offers minimal improvement in actual legibility and can compromise clarity when used in code. Especially since having fields that don't form a sentence does not reduce the understandability of the data structure, as the field names remain self-explanatory. P.S. And If a more user-friendly presentation of the data is really required, creating a display interface to transform this structured data into readable sentences would be quite straightforward. |
|
In my opinion, the |
What about having industry being an array: or In this way, the data can be extended as and when required. |
That's a good idea! I was more thinking of a If you'd like to add it, could you rather use the code suggestion feature (or open a PR on top of that PR)? 🙂 |
I would go for a |
|
The discussion in the GitHub comments makes it difficult to summarise the current state of proposals. The core team is planning a discussion session (1 hour maximum) on Monday 4 November at 2pm UTC, open to anyone who wishes to take part to finalise the proposals that will be put to the vote. This will take place online here. In the meantime, discussions will of course remain open here. |
|
Following the sync call, i updated the proposals. We welcome your feedback. |
Great to see that the synchronous call has paid off, I really like the solution C. 👏 I have two more suggestions to make:
Solution C.2"<terms type name>": {
"topic": "...",
"aliases": [ // Optional array of strings
"..."
],
"applicability": { // Optional object defining scope
"obligee": [ // Array of strings defining the parties obligated by the terms
"..."
],
"jurisdictions": [ // Array of ISO 3166-2 region codes
"..."
],
"industries": [ // Array of strings
"..."
]
},
"references": { // Optional object with name/url pairs
"name": "url"
}
}Examples1. Editorial Policy "Editorial Policy": {
"topic": "writing and publishing standards and principles",
"aliases": [
"Editorial Guidelines"
],
"applicability": {
"obligee": [
"end user",
"content contributors"
]
},
"references": {
"Open Terms Archive discussion": "https://github.com/OpenTermsArchive/terms-types/discussions/35"
}
}2. Conditions of Carriage "Conditions of Carriage": {
"topic": "benefits and limitations associated with the transportation being provided",
"aliases": [
"Transport Conditions"
],
"applicability": {
"obligee": [
"passenger",
"sender"
],
"industries": [
"Air Transport",
"Maritime Transport",
"Rail Transport",
"Road Freight and Trucking",
"Public Transit (Bus, Metro)",
"Delivery and Courier Services"
]
}
}3. Anti-corruption Policy "Anti-corruption Policy": {
"topic": "risk mitigation and prevention of involvement in bribery",
"aliases": [
"Anti-bribery Policy"
],
"applicability": {
"obligee": [
"employees",
"contractors",
"partners"
],
"jurisdictions": [
"US",
"GB",
"FR"
]
},
"references": {
"Open Terms Archive discussion": "https://github.com/OpenTermsArchive/terms-types/discussions/39",
"🇺🇸 Foreign Corrupt Practices Act": "https://www.justice.gov/criminal/criminal-fraud/foreign-corrupt-practices-act",
"🇬🇧 Bribery Act 2010": "https://www.legislation.gov.uk/ukpga/2010/23/contents",
"🇫🇷 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"
}
} |
|
Thank you @Ndpnt for this suggestion 👏 |
|
As the deadline is approaching, I'd like to invite everyone to vote by 11 November AoE. As a reminder, there are 4 proposals A, B, C1, C2 Please indicate your choice in the comments. |
|
I vote for C2! |
MattiSG
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I vote for C1.
|
I also vote for C1. |
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Nicolas Dupont <npg.dupont@gmail.com>
5396e42 to
5aa9c28
Compare
|
Thank you all for your participation. Solution C1 has been selected. |
This PR is an experiment to create RFC that will lead to a decision record delivery.
The idea is to add comments right onto the document, much like you would with code. I will update the document for each consensus reached.
The deadline for this RFC is November 11 end of day AoE (Anywhere on Earth).