Verified Commit 1b1aa7f7 authored by Levente Polyak's avatar Levente Polyak 🚀
Browse files

fix(doc): improve splitting topics across README.md and CONTRIBUTING.md

parent c2140223
......@@ -4,43 +4,40 @@ These are the contribution guidelines for archlinux-keyring.
All code contributions fall under the terms of the GPL-3.0-or-later (see
[LICENSE](LICENSE)).
Any merge request to the repository requires two approvals of authorized
approvers (the current main key holders).
## Keyringctl
Please read our distribution-wide [Code of
Conduct](https://terms.archlinux.org/docs/code-of-conduct/) before
contributing, to understand what actions will and will not be tolerated.
The `keyringctl` script is written in typed python, which makes use of
[sequoia](https://sequoia-pgp.org/)'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`.
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
## Key directories
Any merge request to the repository requires two approvals of authorized
approvers (the current main key holders).
This repository contains PGP packet data, that describes the trusted signing
keys (below [main](main)) and the packager keys (below [packagers](packagers))
of the distribution.
## Discussion
Import of a new main key is done using
Discussion around archlinux-keyring may take place on the [arch-projects
mailing list](https://lists.archlinux.org/listinfo/arch-projects) and in
[#archlinux-projects](ircs://irc.libera.chat/archlinux-projects) on [Libera
Chat](https://libera.chat/).
```bash
./keyringctl import --main --name <username> <file>
```
All past and present authors of archlinux-keyring are listed in
[AUTHORS](AUTHORS.md).
Updates to existing main keys is done using
## Requirements
```bash
./keyringctl import --main <file_or_directory>
```
The following additional packages need to be installed to be able to lint
and develop this project:
Import of a new packager key is done using
* python-black
* python-isort
* flake8
* mypy
```bash
./keyringctl import --name <username> <file>
```
## Keyringctl
Updates to existing packager keys is done using
The `keyringctl` script is written in typed python, which makes use of
[sequoia](https://sequoia-pgp.org/)'s `sq` command.
```bash
./keyringctl import <file_or_directory>
```
The script is type checked, linted and formatted using standard tooling.
When providing a merge request make sure to run `make lint`.
......@@ -18,34 +18,42 @@ from the provided data structure and to install it:
* python
* sequoia-sq
## Installation
## Usage
To install archlinux-keyring system-wide use the included `Makefile`:
Import of a new packager key
```bash
make install
./keyringctl import <username>.asc
# alternatively override the username otherwise derived from the filename
./keyringctl import --name <username> <file>
```
## Contribute
Updates to existing packager keys
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
```bash
# username is automatically derived from the fingerprint
./keyringctl import <file_or_directory>
```
Please read our distribution-wide [Code of
Conduct](https://terms.archlinux.org/docs/code-of-conduct/) before
contributing, to understand what actions will and will not be tolerated.
Import of a new main key
Read our [contributing guide](CONTRIBUTING.md) to learn more about how to
provide fixes or improvements for the code base and how to add, update or
remove key material.
```bash
# same options as packager key except mandatory --main
./keyringctl import --main <username>.asc
```
Discussion around archlinux-keyring may take place on the [arch-projects
mailing list](https://lists.archlinux.org/listinfo/arch-projects) and in
[#archlinux-projects](ircs://irc.libera.chat/archlinux-projects) on [Libera
Chat](https://libera.chat/).
## Installation
To install archlinux-keyring system-wide use the included `Makefile`:
```bash
make install
```
## Contribute
All past and present authors of archlinux-keyring are listed in
[AUTHORS](AUTHORS.md).
Read our [contributing guide](CONTRIBUTING.md) to learn more about guidelines and
how to provide fixes or improvements for the code base.
## Releases
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment