@@ -5,7 +5,7 @@ This document provides helpful information for those who like to start hacking o
== Patch Format
Code patches should comply to Metrics Team's [[MetricsJavaStyleGuide|Java Style Guide]].
Git commit messages should generally follow [https://git-scm.com/book/ch5-2.html#Commit-Guidelines these commit guidelines], that is, start with a summary of no more than 50 characters, a blank line, and one or more paragraphs with no more than 72 characters per line.
Git commit messages should generally follow [these commit guidelines](https://git-scm.com/book/ch5-2.html#Commit-Guidelines), that is, start with a summary of no more than 50 characters, a blank line, and one or more paragraphs with no more than 72 characters per line.
Once you completed a patch, format your patch using `git format-patch` if you want to submit just a single, small commit.
If you want to submit more than one commit, push your changes to a public Git repository somewhere that can be pulled from.
...
...
@@ -16,10 +16,10 @@ Here we list some tools we use for making development easier. Using them is not
== Vagrant
Quite a few Metrics products have their own server setup, environment, and data structure - take a look at Onionoo or CollecTor to just name two.
So, for troubleshooting it can be useful to have virtual machines around that simulate the server. One tool to make virtual machine maintenance easier is [https://vagrantup.com Vagrant].
So, for troubleshooting it can be useful to have virtual machines around that simulate the server. One tool to make virtual machine maintenance easier is [Vagrant](https://vagrantup.com).
Attached are descriptions for a Vagrant Onionoo setup as example.
'''Please be aware that the referenced vm-file from puppetlabs has not been verified by us, i.e. use at your own risk.'''
**Please be aware that the referenced vm-file from puppetlabs has not been verified by us, i.e. use at your own risk.**
=== Vagrant for Onionoo Example
...
...
@@ -50,15 +50,15 @@ Create a Debian Wheezy 64 bit instance:
This command downloads the virtual machine imagine, unless it has been
downloaded before, creates a new virtual machine, and runs the bootstrap
script in `vagrant/bootstrap.sh`, if you created the vagrant folder and downloaded the attached bootstrap.sh into it.
'''This may take a few minutes, because the script downloads the virtual machine.'''
**This may take a few minutes, because the script downloads the virtual machine.**
Once this is all done, log into the virtual machine and change to the
Onionoo working directory:
{{{
```
vagrant ssh
cd /srv/onionoo.torproject.org/onionoo/
}}}
```
Important: better avoid running Ant in the `/vagrant/` directory (which
is shared with the host), or the guest system will write directly to the
