From 2bb640581a111dc367c7c29c85e218c664e64bc6 Mon Sep 17 00:00:00 2001 From: daniel-wtd Date: Thu, 28 Mar 2019 17:07:19 +0100 Subject: [PATCH 1/4] feat: kudos.txt Adding kudos.txt, which is quite stable for now and some styleguide stuff. - update: README.md - update: docs/SYTELGUIDE.md - update: docs/CONTRIBUTING.md - update: kudos.txt and templates/kudos.txt.j2 Resolves: #15 See also: #3 --- README.md | 11 +++- docs/CONTRIBUTING.md | 4 +- docs/STYLE_GUIDE.md | 144 ++++++++++++++++++++++++++++++++++++----- kudos.txt | 27 ++++---- templates/kudos.txt.j2 | 45 +++++++------ 5 files changed, 178 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 8ebf3e3..a3c4348 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,10 @@ A repository containing some documents and templates. ## Motivation -During the past years, While True Do opened and closed some repositories. -Keeping track of documents and templates should be easy and centrally manageable. +During the past years, while-true-do.io opened and closed some repositories. We +faced the situation, that maintaining Guidelines and other general purpose +documents was somewhat tedious. Keeping track of documents and templates should +be easy and centrally manageable. ## Description @@ -61,10 +63,13 @@ git clone https://github.com/while-true-do/doc-library.git 1. Enable .gitmessage as commit template ``` + # Only for the repository git config commit.template .gitmessage + # Global for all repositories + git config --global commit.template .gitmessage ``` -2. Copy the files from ./templates to the desired destination +2. Copy and rename the files from ./templates to the desired destination 3. Edit the files properly (at least "{{ WTD_REPO_NAME }}" must be replaced) 4. Update all "TODO" Sections to your likings diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f24a14b..e73f90f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -7,7 +7,7 @@ license: BSD-3-Clause --> # Contribution Code -While True Do Contribution Guidelines +while-true-do.io Contribution Guideline ## Welcome @@ -41,7 +41,7 @@ whole [Code of Conduct](./CODE_OF_CONDUCT.md). ## Project Contribution -Contributing to While True Do is appreciated. We are open for new ideas, +Contributing to while-true-do.io is appreciated. We are open for new ideas, helping with the community, bug reports, helps with testing, etc. In this section you will find some hints. If your way of contribution is not explained here, please feel free to discuss your idea with us. diff --git a/docs/STYLE_GUIDE.md b/docs/STYLE_GUIDE.md index 0a5e826..25e6523 100644 --- a/docs/STYLE_GUIDE.md +++ b/docs/STYLE_GUIDE.md @@ -7,23 +7,32 @@ license: BSD-3-Clause --> # Style Guide - +while-true-do.io Style Guide -The Style Guide is in DRAFT. Please take everything stated here with a grain of -salt. As an orientation we used . +## Table of Contents - +- [Intro](#intro) +- [Logo](#logo) +- [Colors](#colors) +- [Typeface](#typeface) +- [Pictographs](#pictographs) +- [Frameworks](#frameworks) -## Table of Contents +## Intro + +while-true-do.io stands for Free/Libre Open Source contribution. It is coming +from the idea, that you should do whatever can be done, as long as it is +needed. Adding content to FLOSS / Open Source in one or another way was and +will always be the key intention behind while-true-do.io. -- [Logo](#Logo) -- [Colors](#Colors) -- [Typeface](#Typeface) -- [Pictographs](#Pictographs) -- [Frameworks](#Frameworks) +The Styling should reflect our intentions, motivation and ideals. ## Logo +The logo is a stylized turtle. The turtle stands for sustainability, +reliability, steadiness and wisdom. The form is defined by the infinity symbol +and is reflecting the "while true do = infinite loop" idea. + ### Logo and Marque @@ -38,23 +47,126 @@ salt. As an orientation we used . ## Colors +Having a fixed set of colors will help to identify while-true-do.io, even when +it is not written explicitly. The below color definitions should be applied, +when possible. + ### Color Palette - +The chosen color palette is directly bound to our main principles and ideals. +Variants and tints can be used, when interface design recommends it. + +--- + +#### sustainability emerald (#2ece72) + + + + + +#### darker variant (#0eae50) + + + + + +--- + +#### reliability turquoise (#1abcac) + + + + + +#### darker variant (#0a9c9c) + + + + + +--- + +#### steadiness grey (#959595) + + + + + +#### darker variant (#757575) + + + + -### Color Tints +--- - +#### wisdom white (#eef0f0) + + + + + +--- + +#### infinity black (#090509) + + + + + +--- ## Typeface -## Typeface Sans +For browser applications (like websites), one should rely on system fonts. +The user is already familiar with his system and should not be forced to use +another font. + +On the other hand, on documents like \*.pdfs, written letters or when creating +images, one should rely on the below typefaces. + +We have chosen a font, which is good looking, well known and easy to read. It +is also under a free license and widely used in Open Source environments. + +**DejaVu Fonts** + +- Name: DejaVu Fonts +- Link: +- License: +- Download: +- Variants: Sans, Serif, Mono + +### Typeface Sans + +Sans fonts are often used on digital presentations like: + +- websites +- mobile applications +- desktop applications + +**Example** - ### Typeface Serif - +Serif fonts are often used for documents on an analog medium like: + +- letters +- paper documents +- brochures + +**Example** + +### Typeface Mono + +Mono fonts are quite technical and should only be used in a technical context +like: + +- code blocks +- terminals + +**Examples** + ## Pictographs diff --git a/kudos.txt b/kudos.txt index 9bf7051..5fac37c 100644 --- a/kudos.txt +++ b/kudos.txt @@ -1,12 +1,17 @@ -# name: kudos.txt -# description: Express gratitude to your contributors. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# reference: https://github.com/kudos-txt +# kudos.txt - Express gratitude to your contributors. +# https://github.com/kudos-txt -## contributors -- name: daniel-wtd - role: owner - site: daniel@while-true-do.io, @daniel-wtd - location: Germany +project: + - name: while-true-do.io + site: https://while-true-do.io + mail: hello@while-true-do.io + +contributors: + - name: daniel-wtd + mail: daniel@while-true-do.io + role: Founder / Owner + site: https://while-true-do.io + +partners: + - name: kudos.txt + site: https://kudos-txt.io diff --git a/templates/kudos.txt.j2 b/templates/kudos.txt.j2 index 28b4b71..f8960a1 100644 --- a/templates/kudos.txt.j2 +++ b/templates/kudos.txt.j2 @@ -1,24 +1,27 @@ -# name: kudos.txt -# description: Express gratitude to your contributors. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# reference: https://github.com/kudos-txt +# kudos.txt - Express gratitude to your contributors. +# https://github.com/kudos-txt -## contributors -TODO: Fill in all information and remove this line. -- name: - role: - site: , , - company: - location: , +project: + - name: while-true-do.io + site: https://while-true-do.io + mail: hello@while-true-do.io -## partners and sponsors -TODO: Fill in all information and remove this line. -- name: - site: , , +contributors: + - name: + code: + home: , + mail: + role: + site: + work: , -## software and tools -TODO: Fill in all information and remove this line. -- name: - license: +partners: + - name: kudos.txt + site: https://kudos-txt.io + + - name: + site: + +software: + - name: + site: From 3de092e36884f3c90e0a300e48d698b6eba8588f Mon Sep 17 00:00:00 2001 From: daniel-wtd Date: Mon, 8 Apr 2019 13:01:11 +0200 Subject: [PATCH 2/4] fix: github cannot display inline svg --- docs/STYLE_GUIDE.md | 48 ++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/STYLE_GUIDE.md b/docs/STYLE_GUIDE.md index 25e6523..caa3cca 100644 --- a/docs/STYLE_GUIDE.md +++ b/docs/STYLE_GUIDE.md @@ -60,59 +60,59 @@ Variants and tints can be used, when interface design recommends it. #### sustainability emerald (#2ece72) - - - +
+ background: #2ece72 +
#### darker variant (#0eae50) - - - +
+ background: #0eae50 +
--- #### reliability turquoise (#1abcac) - - - +
+ background: #1abcac +
#### darker variant (#0a9c9c) - - - +
+ background: #0a9c9c +
--- #### steadiness grey (#959595) - - - +
+ background: #959595 +
#### darker variant (#757575) - - - +
+ background: #757575 +
--- #### wisdom white (#eef0f0) - - - +
+ background: #eef0f0 +
--- #### infinity black (#090509) - - - +
+ background: #090509 +
--- From 226341e7e9e645321d54880dc431800ee3d54a57 Mon Sep 17 00:00:00 2001 From: daniel-wtd Date: Mon, 8 Apr 2019 13:24:25 +0200 Subject: [PATCH 3/4] fix: github does not display css --- docs/STYLE_GUIDE.md | 34 ++++++++++------------------------ docs/img/col_090509.png | Bin 0 -> 295 bytes docs/img/col_0a9c9c.png | Bin 0 -> 294 bytes docs/img/col_0eae50.png | Bin 0 -> 296 bytes docs/img/col_1abcac.png | Bin 0 -> 297 bytes docs/img/col_2ece72.png | Bin 0 -> 296 bytes docs/img/col_757575.png | Bin 0 -> 293 bytes docs/img/col_959595.png | Bin 0 -> 294 bytes docs/img/col_eef0f0.png | Bin 0 -> 295 bytes docs/img/col_overview.png | Bin 0 -> 875 bytes 10 files changed, 10 insertions(+), 24 deletions(-) create mode 100644 docs/img/col_090509.png create mode 100644 docs/img/col_0a9c9c.png create mode 100644 docs/img/col_0eae50.png create mode 100644 docs/img/col_1abcac.png create mode 100644 docs/img/col_2ece72.png create mode 100644 docs/img/col_757575.png create mode 100644 docs/img/col_959595.png create mode 100644 docs/img/col_eef0f0.png create mode 100644 docs/img/col_overview.png diff --git a/docs/STYLE_GUIDE.md b/docs/STYLE_GUIDE.md index caa3cca..07d33c3 100644 --- a/docs/STYLE_GUIDE.md +++ b/docs/STYLE_GUIDE.md @@ -56,63 +56,49 @@ when possible. The chosen color palette is directly bound to our main principles and ideals. Variants and tints can be used, when interface design recommends it. +![overview](img/col_overview.png) + --- #### sustainability emerald (#2ece72) -
- background: #2ece72 -
+![2ece72](img/col_2ece72.png) #### darker variant (#0eae50) -
- background: #0eae50 -
+![0eae50](img/col_0eae50.png) --- #### reliability turquoise (#1abcac) -
- background: #1abcac -
+![1abcac](img/col_1abcac.png) #### darker variant (#0a9c9c) -
- background: #0a9c9c -
+![0a9c9c](img/col_0a9c9c.png) --- #### steadiness grey (#959595) -
- background: #959595 -
+![959595](img/col_959595.png) #### darker variant (#757575) -
- background: #757575 -
+![757575](img/col_757575.png) --- #### wisdom white (#eef0f0) -
- background: #eef0f0 -
+![eef0f0](img/col_eef0f0.png) --- #### infinity black (#090509) -
- background: #090509 -
+![090509](img/col_090509.png) --- diff --git a/docs/img/col_090509.png b/docs/img/col_090509.png new file mode 100644 index 0000000000000000000000000000000000000000..9b39aebb1cf327270e2b39bfdbfccd1e7b06a1eb GIT binary patch literal 295 zcmeAS@N?(olHy`uVBq!ia0vp^DIm) z^mS!_%)-Gfsw>1V0hD8qEOCt}an8@pP0cG|a4t$sEJ;mKD9}YJYP-) z^mS!_%)-GfVv%<8Y$s4ivcxr_#5q4VH#M(>!MP|ku_QG`p**uBL&4qCHz2%`PaLRd zfv1aONX4zU7YrF07+4q#=KPv}Xw`$yIfBz{h3`yZirkcPa+0cdqYjv{)L|N!5v1S^ yW@t`O1v5lW0M!6RxWJ01>99g{O`}}) z^mS!_%)-GfA`^8=GXf|iS>hT|;+&tGo0?a`;9QiNSdyBeP@Y+mq2TW68xY>eCk|A! z$kW9!q~g}w3x~K4iSIL1JA$(6tPnu6{1-oD!M<`U+zW literal 0 HcmV?d00001 diff --git a/docs/img/col_1abcac.png b/docs/img/col_1abcac.png new file mode 100644 index 0000000000000000000000000000000000000000..bcdf906442d7083bd8ddca912f8fe71646be6dd2 GIT binary patch literal 297 zcmeAS@N?(olHy`uVBq!ia0vp^DIm) z^mS!_%)-GfqBXT(&q1J&WQl7;iF1B#Zfaf$gL6@8Vo7R>LV0FMhJw4NZ$Nk>pEyv_ zVow*xkcwMxFDNoH7;rFb_$={dx{HF0Xu%BKLrS~ltm7MXA~&U+oV3(o8kiBJ;0) z^mS!_%)-Gf!hKV6&3vGcWQl7;iF1B#Zfaf$gL6@8Vo7R>LV0FMhJw4NZ$Nk>pEyv_ zB2O2`kcwMxFBmd17;rEw*y+$_ykh2>2hW)WJKj{isbSrea&nTY_cW$R2%}L4%vkC$ z4a^8q@CGw9Cjiv|MMO@36zfECL3HU*u02+|Ese=+r~Tb+K-V&Oy85}Sb4q9e0P?J3 A) z^mS!_%)-GfDz=#ABRfz?vcxr_#5q4VH#M(>!MP|ku_QG`p**uBL&4qCHz2%`PaLRd zzNd?0NX4zU7YrF07&w>}wtoH) z^mS!_%)-Gf%Bjcm=Mzv!vcxr_#5q4VH#M(>!MP|ku_QG`p**uBL&4qCHz2%`PaLRd zfv1aONX4zU7Ze#87&w>>7VNK$*Lq+O-BLQ~QJTn!Nvht{bRxM@PJ$V%n;;CPNC=}* x2h3RN08|4M2~q$l-jt#_0jz5i<=VgIGVWn#YJY#7X*$rY44$rjF6*2UngG@!Vl4mw literal 0 HcmV?d00001 diff --git a/docs/img/col_eef0f0.png b/docs/img/col_eef0f0.png new file mode 100644 index 0000000000000000000000000000000000000000..e342952d4bbcbd676084fa43a74f96ac8fee601b GIT binary patch literal 295 zcmeAS@N?(olHy`uVBq!ia0vp^DIm) z^mS!_%)-GfswllPgaarfS>hT|;+&tGo0?a`;9QiNSdyBeP@Y+mq2TW68xY>eCk|A! z(9^{+q~g}w3yy*e3@i)=U(UaB2{?E@y?eu(nGcqUoS3BQJxwQ)E9E4Z!MX{;V2Xq= z8g;;or4B$fK#?E?km5}#niIgfHc_tqYc8Y3Gv;X<*D0m~9n0Y9>gTe~DWM4f8X;su literal 0 HcmV?d00001 diff --git a/docs/img/col_overview.png b/docs/img/col_overview.png new file mode 100644 index 0000000000000000000000000000000000000000..5761eb51f366a401e9154beefd2016256a7f8dbd GIT binary patch literal 875 zcmeAS@N?(olHy`uVBq!ia0y~yVEh7PpWt8vl5FMt$VlDE4H!+#K5uy^@npa^Gy zM`SSrgPt-7Ggd6MF9Qm)mw5WRvOi|w;1<>}vG>*j3Q3l@MwB?`=jNv7l`uFLr6!i7 zrYMwWmSiZnd-?{1H}Z)yFfd*Aba4!+xb^n>M$VQ15toal8(En*GBa~;5Z=gr`E6mb zaOFyc{Y;LhKPWz*VsJ8b)x-TU@|P@5Wwf}|z0PZKSypN0q!fEuN^#68g+&om2dKfCe%0Y6(X@}bYRgc0a!w70>!Rv1tIMn7T+mqP>zwU|thy>;V N22WQ%mvv4FO#sO9&olr4 literal 0 HcmV?d00001 From 429686edb3e198190cc88d083f07dba59df85b52 Mon Sep 17 00:00:00 2001 From: daniel-wtd Date: Mon, 8 Apr 2019 13:34:45 +0200 Subject: [PATCH 4/4] feat: add more shields - update: README.md.j2 for template use - update: README.md to apply new templates Resolves: #7 --- README.md | 4 ++++ templates/README.md.j2 | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index a3c4348..7226146 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,12 @@ author: while-true-do.io contact: hello@while-true-do.io license: BSD-3-Clause --> + ![](https://img.shields.io/github/license/while-true-do/doc-library.svg?style=flat) ![](https://img.shields.io/github/issues/while-true-do/doc-library.svg?style=flat) +![](https://img.shields.io/github/issues-pr/while-true-do/doc-library.svg?style=flat) + +[![Build Status](https://travis-ci.org/while-true-do/doc-library.svg?branch=master)](https://travis-ci.org/while-true-do/doc-library) # doc-library diff --git a/templates/README.md.j2 b/templates/README.md.j2 index 69f2850..255e822 100644 --- a/templates/README.md.j2 +++ b/templates/README.md.j2 @@ -5,8 +5,12 @@ author: while-true-do.io contact: hello@while-true-do.io license: BSD-3-Clause --> + ![](https://img.shields.io/github/license/while-true-do/{{ WTD_REPO_NAME }}.svg?style=flat) ![](https://img.shields.io/github/issues/while-true-do/{{ WTD_REPO_NAME }}.svg?style=flat) +![](https://img.shields.io/github/issues-pr/while-true-do/{{ WTD_REPO_NAME }}.svg?style=flat) + +[![Build Status](https://travis-ci.org/while-true-do/{{ WTD_REPO_NAME }}.svg?branch=master)](https://travis-ci.org/while-true-do/{{ WTD_REPO_NAME }}) # {{ WTD_REPO_NAME }}