CondorCORE/condorcore-keyring
CondorCORE/condorcore-keyring
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Levente Polyak 2021-10-20 20:13:48 +02:00
parent c214022300
commit 1b1aa7f738
No known key found for this signature in database
GPG Key ID: FC1B547C8D8172C8
2 changed files with 53 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
CONTRIBUTING.md
View File

@ -4,9 +4,36 @@ 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)).
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.
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
Any merge request to the repository requires two approvals of authorized
approvers (the current main key holders).
## Discussion
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/).
All past and present authors of archlinux-keyring are listed in
[AUTHORS](AUTHORS.md).
## Requirements
The following additional packages need to be installed to be able to lint
and develop this project:
* python-black
* python-isort
* flake8
* mypy
## Keyringctl
The `keyringctl` script is written in typed python, which makes use of
@ -14,33 +41,3 @@ The `keyringctl` script is written in typed python, which makes use of
The script is type checked, linted and formatted using standard tooling.
When providing a merge request make sure to run `make lint`.
## Key directories
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.
Import of a new main key is done using
```bash
./keyringctl import --main --name <username> <file>
```
Updates to existing main keys is done using
```bash
./keyringctl import --main <file_or_directory>
```
Import of a new packager key is done using
```bash
./keyringctl import --name <username> <file>
```
Updates to existing packager keys is done using
```bash
./keyringctl import <file_or_directory>
```

44
README.md
View File

@ -18,6 +18,30 @@ from the provided data structure and to install it:
* python
* sequoia-sq
## Usage
Import of a new packager key
```bash
./keyringctl import <username>.asc
# alternatively override the username otherwise derived from the filename
./keyringctl import --name <username> <file>
```
Updates to existing packager keys
```bash
# username is automatically derived from the fingerprint
./keyringctl import <file_or_directory>
```
Import of a new main key
```bash
# same options as packager key except mandatory --main
./keyringctl import --main <username>.asc
```
## Installation
To install archlinux-keyring system-wide use the included `Makefile`:
@ -28,24 +52,8 @@ make install
## Contribute
Development of archlinux-keyring takes place on Arch Linux' Gitlab:
https://gitlab.archlinux.org/archlinux/archlinux-keyring.
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.
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.
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/).
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