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
74
75
76
77
78
79
80
81
82
83
84
|
# Contributing to Cosign
Thank you for considering contributing to Cosign! We welcome any contributions, whether it's bug fixes, new features, or improvements to the existing codebase.
## Your First Pull Request
Review [Sigstore's contribution guidelines](https://github.com/sigstore/community/blob/main/CONTRIBUTING.md) which includes some high level information on how to contribute to Sigstore projects.
To help you get familiar with our contribution process, we have a list of [good first issues](https://github.com/sigstore/cosign/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which are relatively limited in scope.
Before working on an issue, please:
1. Check the comments to see if someone is already working on it.
1. If it's unassigned, comment that you're working on it to avoid duplication.
## Contribution Prerequisites
Before running Cosign, ensure that you have [Go](https://go.dev/doc/install) installed.
## Sending a Pull Request
You can find a step by step guide to submit your contribution on [Sigstore's contribution guidelines](https://github.com/sigstore/community/blob/main/CONTRIBUTING.md#pull-request-process).
The following steps describe the build, unit testing, linting, and documentation processes:
### Building Cosign
To build cosign locally, run this command:
```shell
make cosign
```
### Running Unit Tests
To run the unit tests, execute the following command:
```shell
make test
```
**Make sure all tests pass** without any failures or errors.
#### Conformance tests
To run the conformance tests, first install the conformance test runner:
```shell
make conformance-runner
```
Then build `cosign` and `conformance` (the executable that adapts conformance tests to the cosign command), and run the tests:
```shell
make cosign conformance
make conformance-tests
```
### Running Lint
To run the linting checks, use the following command:
```shell
make lint
```
Address any linting warnings or errors before submitting your PR.
### Document Generation
If your changes require updates to project documentation, run the following:
```shell
make docgen
```
Ensure that the documentation is up-to-date and reflects your changes accurately.
### Sign DCO
Make sure to sign the [Developer Certificate of Origin](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff).
## Additional Documentation
In addition to the README file, documentation for Cosign exists in the repository's doc folder and consists of one markdown file for each command. If you add, delete or modify a Cosign command you must also add, delete, or edit the appropriate file in the doc folder.
|
