Contributors Guidelines to PySyft-TensorFlow

Getting Started

Slack

A great first place to join the Community is the Slack channel.

Issues

The open issues, including good first issues, can be found here. This repository works with issues the same way as the PySyft repository.

Setup

Forking a Repository

To contribute, you will need to send your pull requests via a fork.

Keeping your fork up to date

If you continue to contribute, you will need to keep your fork up to date. See this guide for instructions detailing how to sync your fork.

Environment

We recommend creating a Conda environment for PySyft-TensorFlow.

$ conda create -n pysyft-tf python=3.7
$ source activate pysyft-tf

Installing Dependencies

After forking the repository and cloning it, you can install the required dependencies

pip install -r requirements.txt
pip install -r requirements_dev.txt

Running Tests

We use pytest to run tests.

$ pytest # run everything
$ pytest -k "test_fn_name_here" # run a specific failing test

Documentation & Codestyle

This repository follows the same rules as PySyft.