alpm-types 0.1.0

Types for Arch Linux Package Management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

<!--
SPDX-FileCopyrightText: 2023 David Runge <dvzrv@archlinux.org>
SPDX-License-Identifier: CC-BY-SA-4.0
-->

# Contributing

These are the contribution guidelines for alpm-types.

Development takes place on Arch Linux's GitLab at
https://gitlab.archlinux.org/archlinux/alpm/alpm-types.

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.

## Writing code

This project is written in [Rust](https://www.rust-lang.org/) and formatted
using the default [rustfmt](https://github.com/rust-lang/rustfmt) of the most
recent version of Rust.

All contributions are linted using 
[clippy](https://github.com/rust-lang/rust-clippy) and spell checked using
[codespell](https://github.com/codespell-project/codespell).

To aide in development, it is encouraged to use the local `.ci/check.sh` script
as [git pre-commit hook](https://man.archlinux.org/man/githooks.5#pre-commit):

```shell
$ ln -f -s ../../.ci/check.sh .git/hooks/pre-commit
```

## Writing commit messages

The commit message style follows
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

To aide in development, install
[cocogitto](https://github.com/cocogitto/cocogitto) and add its
[git-hooks](https://man.archlinux.org/man/githooks.5):

```shell
$ cog install-hook all
```

## Creating releases

Releases are created by the developers of this project using
[cocogitto](https://github.com/cocogitto/cocogitto) by running:

```shell
cog bump --auto
```

The above will automatically bump the version based on the commits since the
last release, add an entry to `CHANGELOG.md`, create a tag and push the changes
to the default branch of the project.

## License

All code contributions fall under the terms of the
[LGPL-3.0-or-later](https://www.gnu.org/licenses/lgpl-3.0.en.html).

All documentation contributions fall under the terms of the
[CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/).

All configuration file contributions fall under the terms of the
[CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).

License identifiers and copyright statements are checked using
[reuse](https://git.fsfe.org/reuse/tool). By using `.ci/check.sh` as git
pre-commit hook, it is run automatically.