Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: kudos.txt #17

Merged
merged 4 commits into from
Apr 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,23 @@ author: while-true-do.io
contact: [email protected]
license: BSD-3-Clause
-->
<!-- github shields -->
![](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)
<!-- travis testing shields -->
[![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

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

Expand Down Expand Up @@ -61,10 +67,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

Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ license: BSD-3-Clause
-->
# Contribution Code

While True Do Contribution Guidelines
while-true-do.io Contribution Guideline

## Welcome

Expand Down Expand Up @@ -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.
Expand Down
130 changes: 114 additions & 16 deletions docs/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,32 @@ license: BSD-3-Clause
-->
# Style Guide

<!-- TODO: Remove DRAFT after finishing -->
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 <https://www.youtube.com/watch?v=OiV3xwyfeWs>.
## Table of Contents

<!-- TODO: Provide a s cool intro and welcome to the guide -->
- [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

<!-- TODO: Provide the Icon and Typography for the logo -->
Expand All @@ -38,23 +47,112 @@ salt. As an orientation we used <https://www.youtube.com/watch?v=OiV3xwyfeWs>.

## 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

<!-- TODO: Provide the 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.

![overview](img/col_overview.png)

---

#### sustainability emerald (#2ece72)

![2ece72](img/col_2ece72.png)

#### darker variant (#0eae50)

![0eae50](img/col_0eae50.png)

---

#### reliability turquoise (#1abcac)

![1abcac](img/col_1abcac.png)

#### darker variant (#0a9c9c)

![0a9c9c](img/col_0a9c9c.png)

---

#### steadiness grey (#959595)

![959595](img/col_959595.png)

#### darker variant (#757575)

![757575](img/col_757575.png)

### Color Tints
---

<!-- TODO: Provide the color tints and variations -->
#### wisdom white (#eef0f0)

![eef0f0](img/col_eef0f0.png)

---

#### infinity black (#090509)

![090509](img/col_090509.png)

---

## 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: <https://dejavu-fonts.github.io>
- License: <https://dejavu-fonts.github.io/License.html>
- Download: <https://dejavu-fonts.github.io/Download.html>
- Variants: Sans, Serif, Mono

### Typeface Sans

Sans fonts are often used on digital presentations like:

- websites
- mobile applications
- desktop applications

**Example**

<!-- TODO: Describe the SANS Font -->

### Typeface Serif

<!-- TODO: Describe the SERIF Font -->
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

Expand Down
Binary file added docs/img/col_090509.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_0a9c9c.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_0eae50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_1abcac.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_2ece72.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_757575.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_959595.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_eef0f0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/col_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 16 additions & 11 deletions kudos.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# name: kudos.txt
# description: Express gratitude to your contributors.
# author: while-true-do.io
# contact: [email protected]
# 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: [email protected], @daniel-wtd
location: Germany
project:
- name: while-true-do.io
site: https://while-true-do.io
mail: [email protected]

contributors:
- name: daniel-wtd
mail: [email protected]
role: Founder / Owner
site: https://while-true-do.io

partners:
- name: kudos.txt
site: https://kudos-txt.io
4 changes: 4 additions & 0 deletions templates/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ author: while-true-do.io
contact: [email protected]
license: BSD-3-Clause
-->
<!-- github shields -->
![](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)
<!-- travis testing shields -->
[![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 }}

Expand Down
45 changes: 24 additions & 21 deletions templates/kudos.txt.j2
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# name: kudos.txt
# description: Express gratitude to your contributors.
# author: while-true-do.io
# contact: [email protected]
# 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: <name>
role: <role in the repository>
site: <url>, <mail>, <social>
company: <company>
location: <city>, <country>
project:
- name: while-true-do.io
site: https://while-true-do.io
mail: [email protected]

## partners and sponsors
TODO: Fill in all information and remove this line.
- name: <name>
site: <url>, <mail>, <social>
contributors:
- name: <name of the contributor>
code: <special code contribution>
home: <city>, <country>
mail: <mail address>
role: <role of the contributor>
site: <url>
work: <workplace>, <company>

## software and tools
TODO: Fill in all information and remove this line.
- name: <name of the software (please include brand marks)>
license: <license>
partners:
- name: kudos.txt
site: https://kudos-txt.io

- name: <name of the partner>
site: <url>

software:
- name: <name of the software>
site: <url>