Browse Source

Merge pull request #4 from franexmo81/fix-typo-CONTRIBUTING.md

fixing typo on CONTRIBUTING.md
main
Joe Standring 4 years ago
committed by GitHub
parent
commit
91771ecb89
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
  1. +1
    -1
      CONTRIBUTING.md

+ 1
- 1
CONTRIBUTING.md View File

@ -2,7 +2,7 @@
One goal of this project is to support as many (reasonable) plugins as possible which the user can enable or disable depending on their needs. This means that new plugins will almost always be a welcome addition.
To ensure that dwm-bar stays compatible, uniform, and efficient there are a few guidelines that should be followed.
The most important part of this project is to have fun using shell scripts. I created this prokect to learn, and learning only happens when mistakes are made, so don't worry too much.
The most important part of this project is to have fun using shell scripts. I created this project to learn, and learning only happens when mistakes are made, so don't worry too much.
## Making/editing a plugin
* Ensure that plugins are POSIX compliant (use ```#!/bin/sh``` instead of ```#!/bin/bash``` etc.). A good way to check this is by using [ShellCheck](https://www.shellcheck.net/) on your script and amending compatibility errors.
* Display plugin output in the terminal. This is easily done by wiriting the plugin in a function and calling the function at the end of the script. This helps with debugging and spotting errors.


Loading…
Cancel
Save