So you want to help improve the infrastructure behind Tails.
Welcome aboard! Please read-on.
First of all, please read the goals and principles of the Tails system administration team.
Essential skills for participating in the Tails infrastructure include basic Unix system administration knowledge and good communication skills.
Depending on the task, you may also need to be knowledgeable in either Debian system administration, scripting in Perl, Python, Ruby or shell, or one of the services we run.
- To complete most tasks, some amount of Puppet work must be done. However, it is possible to participate without knowing Puppet, at least for your first contributions.
- Being an expert beforehand is not required, as long as you are ready to learn whatever you need to know :)
We use Redmine to manage our list of tasks:
Here are a few tips to pick a task:
- Focus on the issues marked as Easy on Redmine.
- Choose something that matters for you.
- Choose something where your singular skills are put to work.
Do not hesitate to request our advice: tell us about your skills, and we will try to match it to a task.
If anything is unclear, ask us to specify the desired outcome in more details before you start working: this will save time to everybody involved.
Thanks to the tools we use, you can contribute usefully without having an account on the actual systems.
A few tasks in Redmine can be fulfilled by testing something, and then reporting your results on the relevant ticket.
However, most tasks are a bit more complicated. Follow these steps to contribute useful bits, that someone else can then integrate into Puppet:
- Prepare configuration, scripts and whatever is needed. During this
- Write down every setup step needed to deploy the whole thing.
- In particular, take note of any dependency you install. Better work in a minimal Debian stable system to avoid missing some (hint: virtual machine, pbuilder chroot or alike).
- Document how the whole thing is supposed to be used.
- Test, hack, test, [...]
- Publish your work somewhere, preferably in a Git repository to smooth any further iteration our first review pass may require. If you already know where to host your personal repositories, this is great; or else you may ask us to host your repository.
- Tell us what problem you tried to solve, and where we can find your solution.
To solve a problem with Puppet, you need to:
- Either, improve a Puppet module. If we are not the original authors of this module, please contribute your changes upstream: we don't want to maintain forks forever.
- Or, create a new Puppet module. But first, try to find an existing module that can be adapted to our needs.
To smooth the reviewing and merging process: create atomic commits, document your changes in details, follow the Puppet style guide, and carefully test your changes.
Once ready, you can submit trivial changes over email, in the form of
Git patches prepared with
For anything more substantial, please publish your work as a Git topic branch. If you already know where to host your personal repositories, this is great; or else you may ask us to host your repository.