RcrdBrt/CV
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Jan Küster 2017-12-18 23:37:15 +01:00 committed by GitHub
parent 488e1edcc0
commit 008231e352
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -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). * 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 * Non-compiling PRs will be rejected
* Always add the main.pdf output as a * 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. * 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 ### Code
* Comments should be added as often as possible. Please see the modern or infographics template for orientation. * Comments should be added as often as possible. Please see the modern or infographics template for orientation.