Welcome to the PrimiHub community!

We value any kind or size of the contribution. If you find a typo in the documentation, or have made improvements, do not hesitate to submit a GitHub pull request. We have many open-source projects. Please feel free to look at the following table.

Name	Description	Skills
PrimiHub	Hyper Multi-Party computing platform	C++ for the core Python for the SDK
HEhub	A library for homomorphic encryption and its applications	C++
PrimiHub Platform	Hyper Multi-Party computing Application	Spring Boot as the backend Vue as the frontend Maven as the build tool
Documentation	The official document of PrimiHub	Powered by Docusaurus 2

Development workflow

Below is a common contribution guide in the PrimiHub community:

Step 1 Fork the project repository

Click the Fork button near the top of the project page. Such as click here to fork the PrimiHub repo. For more details, see this guide.

Step 2 Clone the fork of the repository

For example, clone the fork of the PrimiHub repo by running the following command

git clone git@github.com:your-account/primihub.git # add --depth 1 if your connection is slow
cd primihub

Step 3 Add remote to the main repository

This saves a reference which you can keep your repository synchronized with the latest changes. For example, run the following command to add the upstream remote to the PrimiHub repo.

git remote add upstream git@github.com:primihub/primihub.git

To check the remote is configured correctly, run git remote -v

Step 4 Build the project from source (if necessary)

Follow this doc to build the Primihub project from source. Then install the Python dependencies. Skip this step if unnecessary, e.g., document contribution.

Step 5 Develop the feature and push your work

First, create a feature branch to hold your development changes.

git checkout -b my_feature

Then, start making changes. When you’re done editing, add changed files using git add and then git commit to record your changes.

git add modified_files​
git commit -m "description of the changes"

It is often helpful to keep your local feature branch synchronized with the latest changes of the main repository.

git fetch upstream develop​
git merge upstream/develop

You might need to solve the conflicts, refer to this doc if needed.

Finally, push the changes to your GitHub account.

git push -u origin my_feature

Step 6 Open a new pull request

Follow these instructions to create a pull request from your fork. Please provide a readable PR title and detailed descriptions.

Join Us

• Twitter
• Gitter