Skip to content

added initial version of contributing markdown #64

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing to Prive

Welcome to Prive the synthetic data privacy toolbox from The Alan Turing Institute.

We encourage everyone to use our package to run privacy tests on their own
datasets using standard generating methods, and to test their new synthetic
generating methods on new or standard datasets.

We welcome contributions either to improve our tooling
fix bugs or add new features.

We would also support adding your own:
- Privacy Attacks
- Threat Models
- Dataset types
- Synthetic Generators

We encourage the standard use of Github Issues and pull requests and subsequent reviews.