From 7922b9d3b2fe1362b85dde898c30e3663feb21e4 Mon Sep 17 00:00:00 2001 From: Andrew Elliott Date: Tue, 28 Jun 2022 19:11:14 +0100 Subject: [PATCH] added initial version of contributing markdown --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5d89f81 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + + +