Guidelines for Contributing to Webi

Before you start:

It's a good idea to try Webi out for installing developer tools for yourself before creating an installer.
It's also best if you take on issues for tools that you're familiar with.

Before you PR:

You'll be asked to make changes if you don't run the code formatters and linters:
- Node / JavaScript:
  - prettier
```
npm run prettier
```
  - jshint
```
npm run lint
```
- Bash
  - shfmt
```
npm run shfmt
```
  - shellcheck
If you use vim, vim-essentials includes everything you need to automatically format and lint on save.
If you use VS Code, the same plugins are also available in the VS Code store.

Not strictly mandatory, but we appreciate:

Signed Commits

Please enable gpg-signing.

You can do this in about 30 seconds:

Run git-config-gpg from Webi:

# On Mac & Linux
curl https://webinstall.dev/git-config-gpg | bash

We try to follow "semantic commits" to some degree. Especially since this is a project with many sub-projects.

The general format is <type>(<package>): <description>, using these types:

type	usage
feat	new feature for the user, not a new feature for build script
fix	bug fix for the user, not a fix to a build script
docs	changes to the documentation
style	formatting, missing semi colons, etc; no production code change
refactor	refactoring production code, eg. renaming a variable
test	adding missing tests, refactoring tests; no production code change
chore	updating grunt tasks etc; no production code change

Try to write your commit messages (in the present tense) like this:

fix(node): update install.sh (fix #200)

feat(delta): add cheat sheet and install.sh

docs(ssh-adduser): document that foo does bar

Whenever adding a new installer, please also update test/install.sh