Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 1.79 KB
Raw

Contributing

These are the contribution guidelines for archzfs-keyring. All code contributions fall under the terms of the GPL-3.0-or-later (see LICENSE).

Please read the Arch Linux's Code of Conduct before contributing, to understand what actions will and will not be tolerated.

Development of archzfs-keyring takes place on ArchZFS GitHub: https://github.com/archzfs.

Any merge request to the repository requires two approvals of authorized approvers (the current main key holders).

Discussion

Discussion around archzfs-keyring may take place in ArchZFS Discussions and in ArchZFS Discord.

Requirements

The following additional packages need to be installed to be able to lint and develop this project:

  • python-black
  • python-coverage
  • python-isort
  • python-pytest
  • python-tomli
  • flake8
  • mypy

Keyringctl

The keyringctl script is written in typed python, which makes use of sequoia's sq command.

The script is type checked, linted and formatted using standard tooling. When providing a merge request make sure to run make lint.

Testing

Test cases are developed per module in the test directory and should consist of atomic single expectation tests. A Huge test case asserting various different expectations are discouraged and should be split into finer grained test cases.

To execute all tests using pytest

make test

To run keyring integrity and consistency checks

make check

Web Key Directory

Only tagged releases are built and exposed via WKD. This helps to ensure, that inconsistent state of the keyring is not exposed to the enduser, which may make use of it instantaneously.