distributed-systems-2019

This repository contains our practical project for the class of distributed systems

Table of Contents

• Status
• Javadocs
• Contributing
• License

Status

Javadocs

The website containing the Javadocs can be found here.

It will always be kept updated.

Contributing

How to start

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/distributed-systems-2019.git
   # Navigate to the newly cloned directory
   cd distributed-systems-2019
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/Cepos-e-Mabecos/distributed-systems-2019.git

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master

5. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

6. Open a Pull Request with a clear title and description against the master branch.

Code guidelines

• Code should follow all Google Style guidelines.
• Code should be formatted according with Java Google Style.

License

By contributing your code, you agree to license your contribution under the MIT License.