mirror of
https://github.com/ben-grande/qusal.git
synced 2025-02-18 22:04:08 -05:00
doc: move contribution guide to docs directory
This commit is contained in:
parent
fd9476c613
commit
7aee0c44d8
@ -5,35 +5,60 @@ Qusal contribution guidelines.
|
|||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
* [Respect](#respect)
|
* [Respect](#respect)
|
||||||
* [Environment](#environment)
|
* [Starters](#starters)
|
||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
* [RPM Spec](#rpm-spec)
|
* [Issues](#issues)
|
||||||
* [Lint](#lint)
|
* [Lint](#lint)
|
||||||
* [Where to start](#where-to-start)
|
|
||||||
|
|
||||||
## Respect
|
## Respect
|
||||||
|
|
||||||
Be respectful towards peers.
|
Be respectful towards peers.
|
||||||
|
|
||||||
## Environment
|
## Starters
|
||||||
|
|
||||||
You will need to setup you development environment before you start
|
There are several ways to contribute to this project. Spread the word, help on
|
||||||
contributing.
|
user support, review opened issues, fix typos, implement new features,
|
||||||
|
donations. Technical knowledge is not always required, if you already
|
||||||
|
understood a problem, give other users your time by linking the solution to
|
||||||
|
them.
|
||||||
|
|
||||||
### Requirements
|
Please read this document and every document linking from here entirely before
|
||||||
|
contributing code or to the documentation. It holds important information on
|
||||||
|
how the project is structured, why some design decisions were made and what
|
||||||
|
can be improved.
|
||||||
|
|
||||||
The following are the packages you need to install:
|
By skipping the read, there is a high change your contribution does not
|
||||||
|
conform to our guidelines and project design, therefore it is going to be
|
||||||
|
rejected. The only exception is a change of guidelines, but this is reserved
|
||||||
|
for users that has a history of contributing to the project, not for starters.
|
||||||
|
|
||||||
|
If you want to understand how Qusal uses Salt features, read our
|
||||||
|
[Salt guide](SALT.md).
|
||||||
|
|
||||||
|
To grasp how the project is structured, why some design decisions were
|
||||||
|
made and what can be improved, see the [design guide](DESIGN.md).
|
||||||
|
|
||||||
|
Experiment with some formulas, read them, understand what is being done.
|
||||||
|
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
For an automatic setup, use the [dev formula](../salt/dev), else, install the
|
||||||
|
packages below depending on the task:
|
||||||
|
|
||||||
General:
|
General:
|
||||||
|
|
||||||
- git
|
- git
|
||||||
|
|
||||||
For writing:
|
For writing:
|
||||||
|
|
||||||
- editorconfig
|
- editorconfig
|
||||||
- editorconfig plugin for your editor
|
- editorconfig plugin for your editor
|
||||||
- vim, [vim-jinja](https://github.com/ben-grande/vim-jinja),
|
- vim, [vim-jinja](https://github.com/ben-grande/vim-jinja),
|
||||||
[vim-salt](https://github.com/ben-grande/vim-salt) (recommended)
|
[vim-salt](https://github.com/ben-grande/vim-salt) (recommended)
|
||||||
|
|
||||||
For linting:
|
For linting:
|
||||||
|
|
||||||
- pre-commit
|
- pre-commit
|
||||||
- gitlint
|
- gitlint
|
||||||
- salt-lint
|
- salt-lint
|
||||||
@ -41,6 +66,7 @@ For linting:
|
|||||||
- reuse
|
- reuse
|
||||||
|
|
||||||
For building RPMs:
|
For building RPMs:
|
||||||
|
|
||||||
- sed (GNU sed)
|
- sed (GNU sed)
|
||||||
- dnf
|
- dnf
|
||||||
- dnf-plugins-core (dnf builddep)
|
- dnf-plugins-core (dnf builddep)
|
||||||
@ -48,20 +74,18 @@ For building RPMs:
|
|||||||
- rpmlint
|
- rpmlint
|
||||||
- rpmautospec (only available in Fedora)
|
- rpmautospec (only available in Fedora)
|
||||||
|
|
||||||
### RPM Spec
|
## Issues
|
||||||
|
|
||||||
Reference material:
|
See open issues and search for the word `TODO` in the repository files.
|
||||||
|
|
||||||
- [docs.fedoraproject.org/en-US/packaging-guidelines/](https://docs.fedoraproject.org/en-US/packaging-guidelines/)
|
Look at the labels `help wanted` and `good first issue` in the issue tracking
|
||||||
- [rpm-software-management.github.io](https://rpm-software-management.github.io/rpm/manual/spec.html)
|
system to get started.
|
||||||
- [rpm-packaging-guide.github.io](https://rpm-packaging-guide.github.io/)
|
|
||||||
- [rpm-guide.readthedocs.io](https://rpm-guide.readthedocs.io/en/latest/rpm-guide.html)
|
|
||||||
- [ftp.rpm.org/max-rpm/s1-rpm-build-creating-spec-file.html](http://ftp.rpm.org/max-rpm/s1-rpm-build-creating-spec-file.html)
|
|
||||||
|
|
||||||
### Lint
|
## Lint
|
||||||
|
|
||||||
Lint before you commit, please... else you will have to fix after the PR has
|
Lint before you commit, please... else you will have to fix after the PR has
|
||||||
already been sent.
|
already been sent, the maintainer has already read and both parties loses
|
||||||
|
time.
|
||||||
|
|
||||||
Install the local hooks:
|
Install the local hooks:
|
||||||
```sh
|
```sh
|
||||||
@ -73,9 +97,3 @@ To run pre-commit linters:
|
|||||||
```sh
|
```sh
|
||||||
pre-commit run
|
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](SALT.md).
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user