Skip to content

Latest commit

 

History

History
134 lines (90 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

134 lines (90 loc) · 4.2 KB
Raw

Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?
  • Which version of this project are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

You need Python 3.12+ and the following tools:

The good thing is to install them you just need [Ansible] and this playbook.

Pre-commit is installed with python_developer tools, Podman and Vagrant with [Nix] packages by default. For Molecule read their docs.

How to test the project

Run the tests locally:

molecule test

Tests are located in the Molecule directory and are executed in Podman containers.

Using Vagrant

To provision this playbook in a VM use our Vagrantfile using VirtualBox or modify the file to use Libvirt.

The VM is created and provisioned with:

vagrant up

The default password for root in the VM is vagrant.

Enabling contrib / non-free / non-free-firmware

Keep in mind one maybe need extra steps to enable extra apt packages eg. to install torbrowser-launcher (from contrib) or firmware-amd-graphics (from non-free-firmware):

  1. comment out provision part of Vagrantfile:

        # Run playbook
    #config.vm.provision "ansible" do |ansible|
    #  ansible.playbook = "main.yml"
    #  ansible.verbose = "vv"
    #end

  2. run vagrant up and then vagrant login

  3. edit /etc/apt/sources.list to add the desired streams eg.:

    deb https://deb.debian.org/debian bookworm main contrib non-free-firmware
deb-src https://deb.debian.org/debian bookworm main contrib non-free-firmware
deb https://deb.debian.org/debian bookworm-updates main contrib non-free-firmware
deb-src https://deb.debian.org/debian bookworm-updates main contrib non-free-firmware
deb https://deb.debian.org/debian-security bookworm-security main contrib non-free-firmware
deb-src https://deb.debian.org/debian-security bookworm-security main contrib non-free-firmware
deb https://deb.debian.org/debian bookworm-backports main contrib non-free-firmware
deb-src https://deb.debian.org/debian bookworm-backports main contrib non-free-firmware

  4. uncomment the provisioning part again on Vagrantfile

  5. run vagrant provision

How to submit changes

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • Pre-commit hooks need to pass.
  • Include tests when relevant. This project maintains a high code coverage.
  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command:

pre-commit install
pre-commit run --all-files

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.