Merge branch 'develop'

Author: JanBobolz

_config.yml

@@ -7,7 +7,7 @@ relative_links:
 theme: minimal-mistakes-jekyll
 minimal_mistakes_skin: "air"
 title: Cryptimeleon
-subtitle: Prototyping of Cryptographic Construction
+subtitle: Prototyping of Cryptographic Constructions
 logo: /assets/logo.png
 repository: cryptimeleon/cryptimeleon.github.io
 locale: en

_data/navigation.yaml

@@ -31,9 +31,7 @@ docs:
       url: /docs/faq.html
 - title: For Contributors
   children:
-    - title: "Project Setup"
-      url: /contributors/setup.html
-    - title: "Snapshot Builds"
+    - title: "How to Contribute"
+      url: /contributors/how-to-contribute.html
+    - title: "Composite Builds"
       url: /contributors/composite-builds.html
-    - title: "Contributing"
-      url: /contributors/contributing.html

contributors/contributing.md

@@ -1,25 +1,37 @@
 ---
-title: Setting Up The Project
+title: How to contribute to the Cryptimeleon libraries
 toc: true
 ---
 
-# Project Setup
+We are glad you are interested in contributing to Cryptimeleon.
+This page will give you an overview of our contribution/developer guidelines and will point you to further information.
 
+## Overview
+
+The Cryptimeleon libraries consist of a number of related cryptographic libraries united under the Cryptimeleon name.
+If you want to contribute, you therefore first need to decide on a specific library.
+Then you can check out that library's issue tracker (we use the Github issue tracker) to find something to work on.
+
+Cryptimeleon's [Github page](https://github.com/cryptimeleon) contains a list of those libraries.
+
+## Project setup
+
+Once you have decided on a library, you will need to clone it and create a project in your favourite IDE.
 All the Cryptimeleon libraries use the [Gradle](https://gradle.org/) build tool. 
 In this guide, we show you how to set up a project in your integrated development environment of choice. 
 This guide is intended for development of the library itself.
 
 If you have problems with building any of the projects, make sure you use the newest version of the Java SDK 8.
 Not all versions of Java 8 are supported.
 
-## Cloning the Repo
+### Forking the repo
 
-Naturally, the first thing to do is to clone the repository containing the library you need. 
-If you are reading this, you probably know how to do this.
+If you don't have write access to the repository, you will need to [fork](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/working-with-forks) the repository of the library you want to modify.
+Then you can apply your changes to that repository.
 
 After this is done, we continue by creating a new project in your favorite IDE.
 
-## Setting up a project in IntelliJ IDEA
+### Setting up a project in IntelliJ IDEA
 
 *Note: This was written for IntelliJ IDEA Version 2019.2.4*
 
@@ -31,7 +43,7 @@ Now browse to the path where you cloned the library repository.
 The repository contains a ``build.gradle`` file. 
 Select it and click **OK**. Once the import process is done, the project is ready for use.
 
-## Setting up a project in Eclipse
+### Setting up a project in Eclipse
 
 *Note: This was written for Eclipse 2020-03 (4.15.0).*
 
@@ -43,23 +55,35 @@ Browse to the location where you cloned the repository to and select the reposit
 For example, ``/home/username/code/craco``. 
 Click **Finish** to finish setup. You can also click **Next** if you want to, for example, select a specific Java SDK.
 
-## Testing Changes
+### Testing changes
 
 Once you have done some changes to a library, you might want to test the effect of these changes on the other libraries.
-For example, as Craco relies on Math, changes to the math library should be followed by testing the craco library with the new changes.
+For example, as Craco relies on Math, changes to the Math library should be followed by testing the craco library with the new changes.
 
 To do this, there are two options: Local installation and composite builds.
 
-### Composite Builds
+#### Composite builds
 
 Composite builds have the advantage of not requiring you to manually install the project each time you want to test its changes. 
 Instead, the dependencies will automatically be newly built when required.
 Furthermore, IDEs such as IntelliJ IDEA have special support for composite builds, allowing you to view the sources for any dependencies included in the composite build.
 
 We recommend using composite builds over the local installation approach. More info on this [here]({% link contributors/composite-builds.md %}).
 
-### Local Installation
+#### Local installation
 
 For any of the libraries you can use the command ``publishToMavenLocal`` in the project root directory to install the library to the local repository (remember to build the newest version via ``gradle build`` before this). 
 To make sure that other libraries actually use local builds and not remote, you need to make sure that local builds are preferred compared to remote builds.
 Hence, `mavenLocal()` should be listed at the top of the `repositories` section in the `build.gradle` file.
+
+## Making changes
+
+When making changes to the code, remember the following things:
+- Stick to the existing code style
+- Add Javadoc whenever necessary
+- Add your changes to the `CHANGELOG.md` file in the root directory
+
+## Contributing your changes
+
+Once you have tested your changes locally, you will want to integrate them into the upstream repository.
+You can do this by [creating a pull request from your fork](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).

contributors/setup.md contributors/how-to-contribute.mdcontributors/setup.md renamed to contributors/how-to-contribute.md

@@ -10,4 +10,10 @@ The Javadoc for the latest version of Cryptimeleon Math can be found [here](http
 
 ## Craco
 
-The Javadoc for the latest version of Cryptimeleon Craco can be found [here](https://javadoc.io/doc/org.cryptimeleon/craco/latest/index.html).
+The Javadoc for the latest version of Cryptimeleon Craco can be found [here](https://javadoc.io/doc/org.cryptimeleon/craco/latest/index.html).
+
+## Predenc
+The Javadoc for the latest version of Cryptimeleon Predenc can be found [here](https://javadoc.io/doc/org.cryptimeleon/predenc/latest/index.html)
+
+## Mclwrap
+The Javadoc for the latest version of Cryptimeleon Predenc can be found [here](https://javadoc.io/doc/org.cryptimeleon/mclwrap/latest/index.html)