From 008231e352e4fa906b3e12ea3ea4b2900ad36e1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 23:37:15 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2af2d10..a28db1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,9 +9,17 @@ Everyone is welcome to open a pull request and improve this package. To maximize * Included `.tex` files should be stored in a folder, e.g. named "lib" (for structural docs) or "g" (for tikz graphics). * Non-compiling PRs will be rejected * Always add the main.pdf output as a -* No interdependencies between templates, please. I know this creates a lot of duplicate code, but there is a clear intention behind this: Users and especially those who are new to LaTeX should have a quick editable, easy to understand and easy to compile template to create their own cv. Therefore each cv should be viewed as a single instance. In the future there may be an enhancement to define the personal credentials in a single file and include it in each cv template. * Make sure, that your PR does not cause a template to exceed the size of one page. This project intends to keep every tamplte short and clear. +### Dependencies + +* There are currently only `tex-live` and `tex-live fonts` as dependencies and most of even complex operations can be implemented (see inforgraphics template). Therefore creating a new package dependecy may defy the goal of being simple to install and compile. +* Solutions using Xetex and Luatax as well as Komascript and others will therefore not be included +* No interdependencies between templates, please. + +I know this creates lots of duplicate code or make it harde to solve a feature request, but there is a clear intention behind this: Users and especially those who are new to LaTeX should have a quick editable, easy to understand and easy to compile template to create their own cv. Therefore each cv should be viewed as a single instance. In the future there may be an enhancement to define the personal credentials in a single file and include it in each cv template. + + ### Code * Comments should be added as often as possible. Please see the modern or infographics template for orientation.