From 118030690970c25a0f023badafe247c1992a3826 Mon Sep 17 00:00:00 2001
From: Eugen Wissner <belka@caraus.de>
Date: Sun, 5 Mar 2023 08:26:21 +0100
Subject: [PATCH] =?UTF-8?q?=E2=80=9EGuidelines=E2=80=9C=20hinzuf=C3=BCgen?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Guidelines.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Guidelines.md

diff --git a/Guidelines.md b/Guidelines.md
new file mode 100644
index 0000000..61cea25
--- /dev/null
+++ b/Guidelines.md
@@ -0,0 +1,56 @@
+# Contributing guidelines
+
+## Testing
+
+To ensure all code changes adhere to existing code quality standards, some automatic checks can be run locally.
+
+Ensure that the code builds without warnings and passes the tests:
+
+```sh
+cabal test
+```
+
+And also run the linter on your code:
+
+```sh
+cabal install hlint
+cabal exec hlint -- src tests
+```
+
+Build the documentation and check if you get any warnings:
+
+```sh
+cabal haddock --enable-documentation
+```
+
+## Submitting changes
+
+Clone the repository or pull the latest changes to your local repository by running:
+
+```sh
+git pull origin master
+```
+
+Create a new branch to work on:
+
+```sh
+git checkout -b branch-name-with-my-changes
+```
+
+After finishing your work commit your changes with
+
+```sh
+git commit
+```
+
+If it is a big changeset you can create multiple commits. Now you can generate a set of patches, that represents the difference between `branch-name-with-my-changes` and `master`:
+
+```sh
+git format-patch master
+```
+
+This command creates a patch for each commit and saves them in the current directory. The patches are numbered sequentially, their filenames contain the the first line of the commit message and their extension is `.patch`.
+
+## Contact
+
+Contributions are very welcome. Send your bug reports, feature requests, questions and patches to belka@caraus.de or open an issue here. Patches can be attached to existing issues, otherwise feel free to create a new one.
\ No newline at end of file