Skip to content

Commit

Permalink
Merge pull request #3 from AIDAUserGroup/dev
Browse files Browse the repository at this point in the history
v2.2 release
  • Loading branch information
jgperrin authored Jul 27, 2023
2 parents d1d79c0 + 2d26d26 commit 8ad4d16
Show file tree
Hide file tree
Showing 13 changed files with 239 additions and 75 deletions.
3 changes: 2 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
| --- | --- | --- |
| [David Austin](https://www.linkedin.com/in/daustin5/) | Revance | Data architect |
| [Laveena Kewlani](https://www.linkedin.com/in/laveena-kewlani-a831485a/) | PayPal | Solutions architect |
| [Jean-Georges Perrin](https://www.linkedin.com/in/jgperrin/) | PayPal | Lead architect |
| [Jean-Georges Perrin](https://www.linkedin.com/in/jgperrin/) | jgp.ai | Principal Technologist |
| [Kruthika Potlapally](https://www.linkedin.com/in/kruthikap/) | Clairvoyant/EXL | Delivery |
| [Amit Sutar](https://www.linkedin.com/in/amitbsutar/) | Clairvoyant/EXL | Delivery & architect |
| Wenjie Guo | PayPal | Developer |
| Shiqi Guo | PayPal | Developer |
| Hongxin Jiang | PayPal | Developer |
| [Kim Thies](https://www.linkedin.com/in/vtkthies/) | ProfitOptics | Advisor |
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
This document tracks the history and evolution of the data contract template. It precedes
This document tracks the history and evolution of the **Open Data Contract Standard**.

# v2.2.0 - 2023-07-27 - APPROVED

* New name to Open Data Contract Standard.
* `templateName` is now called `standardVersion`, v2.2.0 parsers should account for this change and support both to avoid a breaking change.
* Added support for `authoritativeDefinitions` at the table level.
* Added many examples.
* Various improvements and typo corrections.
* Finalization of fork under AIDA User Group.

# v2.1.1 - 2023-04-26 - APPROVED

Expand All @@ -12,7 +21,7 @@ The data contract adds elements specifically for interfacing with the Data Quali

Additions:
* quality (table level & column level check):
* templateName
* templateName (called standardVersion since v2.2.0)
* dimension
* type
* severity
Expand Down
21 changes: 8 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Template for Data Contract


# Contributing to Data Contract Template
# Open Data Contract Standard

## Executive summary
First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
Expand All @@ -27,14 +25,14 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Code of Conduct

This project and everyone participating in it is governed by the
[Data Contract Template Code of Conduct](blob/master/CODE_OF_CONDUCT.md).
[Open Data Contract Standard Code of Conduct](blob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to [@jgperrin](https://github.com/jgperrin).


## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/paypal/data-contract-template).
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/AIDAUserGroup/open-data-contract-standard).
Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

Expand All @@ -58,7 +56,7 @@ This section guides you through submitting an enhancement suggestion for Data Co
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://github.com/paypal/data-contract-template) carefully and find out if the functionality is already covered.
- Read the [documentation](https://github.com/AIDAUserGroup/open-data-contract-standard) carefully and find out if the functionality is already covered.
- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

Expand All @@ -70,13 +68,10 @@ Enhancement suggestions are tracked as [GitHub issues](/issues).
- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- **Explain why this enhancement would be useful** to most Data Contract Template users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Explain why this enhancement would be useful** to most Open Data Contract Standard users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

### Improving The Documentation
<!-- TODO
Updating, improving and correcting the documentation
-->
Please contact [@jgperrin](https://github.com/jgperrin). Examples are always welecome.

## Join The Project Team
<!-- TODO -->
Please contact [@jgperrin](https://github.com/jgperrin).
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Template for Data Contract
# Open Data Contract Standard

Welcome!

Thanks for your interest and for taking the time to come here! ❤️

## Executive summary
This project describes the **data contract** being used to implement Data Mesh at [PayPal](https://about.pypl.com/). It is available for you as an Apache 2.0 license. Contributions are welcome!
This standard describes a structure for a **data contract**. It's current version is 2.2.0. It is available for you as an Apache 2.0 license. Contributions are welcome!

## Discover the template
Discover the [template](https://github.com/AIDAUserGroup/data-contract-template/blob/main/docs/README.md). This file contains some explanations and several examples.
## Discover the open standard
Discover the [Open Data Contract Standard](./docs/README.md). This file contains some explanations and several examples. More [examples](./examples/README.md) have been added to v2.2.

## What is a Data Contract?

Expand All @@ -21,12 +21,12 @@ A data contract defines the agreement between a data producer and consumers. A d
* Security & stakeholders.
* Custom properties.

![Data contract schema](https://github.com/AIDAUserGroup/data-contract-template/blob/main/docs/img/data-contract-v2-schema.png "Data contract schema")
![Data contract schema](./docs/img/data-contract-v2.2-schema.png "Data contract schema")

*Figure 1: illustration of a data contract, its principal contributors, sections, and usage.*

## Contributing to the project
Check out the [CONTRIBUTING](https://github.com/AIDAUserGroup/data-contract-template/blob/main/CONTRIBUTING.md) file.
Check out the [CONTRIBUTING](./CONTRIBUTING.md) file.

## Articles

Expand All @@ -36,9 +36,14 @@ Check out the [CONTRIBUTING](https://github.com/AIDAUserGroup/data-contract-temp
* 2023-05-05 - [Jonathan Neo (j__neo ) on Reddit](https://www.reddit.com/r/dataengineering/comments/137glbo/comment/jixw5hj/?utm_source=reddit&utm_medium=web2x&context=3)
* 2023-05-01 - [PayPal open sources its data contract template](https://jgp.ai/2023/05/01/paypal-open-sources-its-data-contract-template/)

If you spot an article about the Data Contract Template, make a pull request!
If you spot an article about the Open Data Contract Standard, make a pull request!

### How do we use Data Contracts at PayPal?
## More

### History
Formerly known as the data contract template, this standard is used to implement Data Mesh at [PayPal](https://about.pypl.com/). Today, started with v2.2.0, it is maintained by a 501c6 non-profit organization called AIDA User Group (Articifial Intelligence, Data, and Analytics User Group).

### How does PayPal use Data Contracts?
PayPal uses data contracts in many ways, but this [article](https://medium.com/paypal-tech/the-next-generation-of-data-platforms-is-the-data-mesh-b7df4b825522) from the [PayPal Technology blog](https://medium.com/paypal-tech) gives a good introduction.


Loading

0 comments on commit 8ad4d16

Please sign in to comment.