From 6b6aa7ee4e6403ca4068417eb574576be90dd360 Mon Sep 17 00:00:00 2001 From: Benoit Chevallier-Mames Date: Mon, 6 Sep 2021 10:05:57 +0200 Subject: [PATCH] doc: add info from Rand about external PR closes #289 --- docs/dev/GETTING-STARTED.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/dev/GETTING-STARTED.md b/docs/dev/GETTING-STARTED.md index c7862b9da..fffd75179 100644 --- a/docs/dev/GETTING-STARTED.md +++ b/docs/dev/GETTING-STARTED.md @@ -160,7 +160,13 @@ After you finish your work, you can leave the docker by using the `exit` command ## Contributing -Now, you have a working environment, and you know what is where in the project. You are ready to contribute! Well, not so fast let's go over some other important things that you need to be careful about. +Now, you have a working environment, and you know what is where in the project. + +There are two ways to contribute to HDK: +- you can open issues to report bugs, typos and suggest ideas +- you can ask to become an official contributor by emailing hello@zama.ai. Only approved contributors can send pull requests, so please make sure to get in touch before you do! + +Let's go over some other important things that you need to be careful about. ### Creating a new branch @@ -206,6 +212,8 @@ To learn more about conventional commits, check [this](https://www.conventionalc ### Before creating pull request +We remind that only official contributors can send pull requests. To become such an official contributor, please email hello@zama.ai. + You should rebase on top of `main` branch before you create your pull request. This is to avoid merge commits and have a clean git log. After you commit your changes to your new branch, you can use the following commands to rebase. ```shell