qusal/docs/CONTRIBUTING.md

Contributing

Qusal contribution guidelines.

Table of Contents

• Respect
• Environment
  • Requirements
  • RPM Spec
  • Lint
• Where to start

Respect

Be respectful towards peers.

Environment

You will need to setup you development environment before you start contributing.

Requirements

The following are the packages you need to install:

General:

• git

For writing:

• editorconfig
• editorconfig plugin for your editor
• vim, vim-jinja, vim-salt (recommended)

For linting:

• pre-commit
• gitlint
• salt-lint
• shellcheck
• reuse

For building RPMs:

• sed (GNU sed)
• dnf
• dnf-plugins-core (dnf builddep)
• rpm
• rpmlint
• rpmautospec (only available in Fedora)

RPM Spec

Reference material:

• docs.fedoraproject.org/en-US/packaging-guidelines/
• rpm-software-management.github.io
• rpm-packaging-guide.github.io
• rpm-guide.readthedocs.io
• ftp.rpm.org/max-rpm/s1-rpm-build-creating-spec-file.html

Lint

Lint before you commit, please... else you will have to fix after the PR has already been sent.

Install the local hooks:

pre-commit install
gitlint install-hook

To run pre-commit linters:

pre-commit run

Where to start

See open issues and search for the word TODO in the repository files.

If you want to understand how Qusal uses Salt features, read our Salt guide.