particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve contributing.md

Browse source 
use auto-answer -y for all commands
mention the script tools/prepare-source
mention the go generate step
This commit is contained in:
Diaa Sami 2021-09-06 23:27:35 +02:00 • committed by Ondřej Budai
parent 04f69db2c0
commit e4d535ea5f
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -21,8 +21,8 @@ $ cd osbuild-composer
2. To install the build-requirements for Fedora and friends, use: 2. To install the build-requirements for Fedora and friends, use:
``` ```
$ sudo dnf group install 'RPM Development Tools' # Install rpmbuild $ sudo dnf group install -y 'RPM Development Tools' # Install rpmbuild
$ sudo dnf builddep osbuild-composer.spec # Install build-time dependencies $ sudo dnf builddep -y osbuild-composer.spec # Install build-time dependencies
$ sudo dnf -y install cockpit-composer # Optional: Install cockpit integration $ sudo dnf -y install cockpit-composer # Optional: Install cockpit integration
$ sudo systemctl start cockpit.socket # Optional: Start cockpit $ sudo systemctl start cockpit.socket # Optional: Start cockpit
``` ```
@ -44,12 +44,13 @@ Alternatively you can use `composer-cli` to interact with the Weldr API. We
don't have any client for the RCM API, so the only option there is a don't have any client for the RCM API, so the only option there is a
plain `curl`. plain `curl`.
When developing the code, use `go` executable to build, run, and test you When developing the code, use `go` executable to generate, build, run, and test you
code [1]: code [1], alternatively you can use the script `tools/prepare-source.sh`:
``` ```
$ go test ./... $ go test ./...
$ go build ./... $ go build ./...
$ go generate ./...
$ go run ./cmd/osbuild-pipeline/ $ go run ./cmd/osbuild-pipeline/
``` ```