diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f97f514..8f70907 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.