Git-Mirrors/qusal
1
0
Fork 0
mirror of https://github.com/ben-grande/qusal.git synced 2024-12-25 15:39:38 -05:00
Code Issues Packages Projects Releases Wiki Activity
7d6e2bf9c9
qusal/docs/CONTRIBUTING.md
Ben Grande d23a6da9fc doc: separate documents per use case 
The main README is very large, by placing the documents in a separate
directory, we allow the user to choose explicitly what they read, giving
a better reading experience and allows a deeper understanding of the
project.
2024-01-22 18:38:04 +01:00

1.7 KiB
Raw Blame History

Contributing

Qusal contribution guidelines.

Table of Contents

Respect

Be respectful towards peers.

Environment

You will need to setup you development environment before you start contributing. You will need Qubes OS R4 or higher.

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:

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.