From e9ffa2ec8c85fd2931345192704f5d1102a917dc Mon Sep 17 00:00:00 2001 From: Daniel S Date: Thu, 11 Apr 2019 15:39:05 +0200 Subject: [PATCH] feat: Version 1.0.0 (#20) - remove: templates/* - update: README.md - remove: testing content Resolves: #19 Resolves: #18 Resolves: #6 See also: #3 --- README.md | 47 ++++-------------- templates/.editorconfig.j2 | 24 ---------- templates/.gitattributes.j2 | 13 ----- templates/.gitignore.j2 | 49 ------------------- templates/.gitmessage.j2 | 65 ------------------------- templates/LICENSE.j2 | 29 ----------- templates/README.md.j2 | 96 ------------------------------------- templates/kudos.txt.j2 | 27 ----------- 8 files changed, 8 insertions(+), 342 deletions(-) delete mode 100644 templates/.editorconfig.j2 delete mode 100644 templates/.gitattributes.j2 delete mode 100644 templates/.gitignore.j2 delete mode 100644 templates/.gitmessage.j2 delete mode 100644 templates/LICENSE.j2 delete mode 100644 templates/README.md.j2 delete mode 100644 templates/kudos.txt.j2 diff --git a/README.md b/README.md index 7226146..241a72f 100644 --- a/README.md +++ b/README.md @@ -5,27 +5,27 @@ author: while-true-do.io contact: hello@while-true-do.io license: BSD-3-Clause --> + +![](https://img.shields.io/github/tag/while-true-do/doc-library.svg) ![](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 -A repository containing some documents and templates. +A repository containing static documents. ## Motivation 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. +documents was somewhat tedious. Keeping track of documents should be easy and +centrally manageable. ## Description -This repository keeps track of common documents and templates. +This repository keeps track of common documents. ### Documents @@ -37,19 +37,6 @@ see updates in the doc-library. - [Contribution Guideline](./docs/CONTRIBUTING.md) - [Versioning](./docs/VERSIONING.md) -### Templates - -Templates are meant as a Starting Point. You should adjust them to your needs -and liking. - -- [.editorconfig](./templates/.editorconfig.j2) -- [.gitattributes](./templates/.gitattributes.j2) -- [.gitignore](./templates/.gitignore.j2) -- [.gitmessage](./templates/.gitmessage.j2) -- [LICENSE](./templates/LICENSE.j2) -- [kudos.txt](./templates/kudos.txt.j2) -- [README.md](./templates/README.md.j2) - ## Requirements None. @@ -57,32 +44,17 @@ None. ## Installation Install from [Github](https://github.com/while-true-do/doc-library) - ``` git clone https://github.com/while-true-do/doc-library.git ``` ## Usage -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 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 +Link to the documents, if needed. ## Testing -Most of the "generic" tests are located in the -[Test Library](https://github.com/while-true-do/test-library). Tests and -instructions for a single repository are located in the -[Test Directory](./tests). +This repository is not tested. ## Contribute @@ -106,6 +78,3 @@ This work is licensed under a [BSD-3-Clause License](https://opensource.org/lice - Mail [hello@while-true-do.io](mailto:hello@while-true-do.io) - IRC [freenode, #while-true-do](https://webchat.freenode.net/?channels=while-true-do) - Telegram - - - diff --git a/templates/.editorconfig.j2 b/templates/.editorconfig.j2 deleted file mode 100644 index 307c7f4..0000000 --- a/templates/.editorconfig.j2 +++ /dev/null @@ -1,24 +0,0 @@ -# name: .editorconfig -# description: This file helps to configure your editor via editorconfig. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# reference: https://editorconfig.org/ - -# top-most EditorConfig file -root = true - -# Unix-style newlines with a newline ending every file -[*] -end_of_line = lf -insert_final_newline = true - -[*.{yml,py,sh}] -charset = utf-8 - -[*.yml] -indent_style = space -indent_size = 2 - -[Makefile] -indent_style = tab diff --git a/templates/.gitattributes.j2 b/templates/.gitattributes.j2 deleted file mode 100644 index 4014a8e..0000000 --- a/templates/.gitattributes.j2 +++ /dev/null @@ -1,13 +0,0 @@ -# name: .gitattributes -# description: This file facilitates gitattributes. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# reference: https://git-scm.com/docs/gitattributes - -# Ignore some files for exports / releases -.editorconfig export-ignore -.gitattributes export-ignore -.gitignore export-ignore -.gitmessages export-ignore -/tests diff --git a/templates/.gitignore.j2 b/templates/.gitignore.j2 deleted file mode 100644 index ad420ea..0000000 --- a/templates/.gitignore.j2 +++ /dev/null @@ -1,49 +0,0 @@ -# name: .gitignore -# description: This file facilitates gitignore. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# reference: https://git-scm.com/docs/gitignore - -# repo specific - -# compiled source -*.com -*.class -*.dll -*.exe -*.o -*.so - -# ansible retry files -*.retry - -# temporary files -*.swp -*.swo -*~ - -# packages -*.7z -*.dmg -*.gz -*.iso -*.jar -*.rar -*.tar -*.zip - -# logs and databases -*.log -*.sql -*.sqlite - -# OS generated files -.DS_Store* -ehthumbs.db -Icon? -Thumbs.db - -# lock files -*.lock -package-lock.json diff --git a/templates/.gitmessage.j2 b/templates/.gitmessage.j2 deleted file mode 100644 index f418fb1..0000000 --- a/templates/.gitmessage.j2 +++ /dev/null @@ -1,65 +0,0 @@ -# name: .gitmessage -# description: This file helps to write better commit messages. -# author: while-true-do.io -# contact: hello@while-true-do.io -# license: BSD-3-Clause -# -# usage: git config commit.template .gitmessage -# -#<------------------------- 72 characters ----------------------------> -# -# Pattern: -# -# : -# -# -# -# - : -# - : -# - : -# -# Resolves: #, # -# See also: #, # -# -#<------------------------- 72 characters ----------------------------> -# -# Example: -# -# feat: Everything OK Button -# -# A long requested Everything OK Button, which will help us a lot! -# -# - add: everything_ok.py -# - remove: not_ok.js -# - update: README.md -# - update: metadata.json -# -# Resolves: #1234 -# See also: #4711, #666 -# -#<------------------------- 72 characters ----------------------------> -# -# Explanation: -# -# --> TAGS -# -# change tags: can be used for all changes -# - add a feature of file is added -# - remove a feature or file is removed -# - update a feature of file was updated -# -# title tags: only use them for the subject line -# - doc documentation -# - feat feature provided -# - fix bug fix, security fix -# - refactor most likely a re-write or re-code -# - style code style -# -# --> SUBJECT, DESCRIPTION -# -# What was done and why was it done? -# -# --> RESOLVES, SEE ALSO -# -# In most cases, it is mandatory to provide an issue number, which is -# addressed. diff --git a/templates/LICENSE.j2 b/templates/LICENSE.j2 deleted file mode 100644 index abcd80e..0000000 --- a/templates/LICENSE.j2 +++ /dev/null @@ -1,29 +0,0 @@ -BSD 3-Clause License - -Copyright (c) 2019, while-true-do.io -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/templates/README.md.j2 b/templates/README.md.j2 deleted file mode 100644 index 255e822..0000000 --- a/templates/README.md.j2 +++ /dev/null @@ -1,96 +0,0 @@ - - -![](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 }} - - - -## Motivation - - - -## Description - - - -## Requirements - - - -## Installation - - - -Install from [Github](https://github.com/while-true-do/{{ WTD_REPO_NAME }}) - -``` -git clone https://github.com/while-true-do/{{ WTD_REPO_NAME }}.git -``` - -## Usage - - - -## Testing - -Most of the "generic" tests are located in the -[Test Library](https://github.com/while-true-do/test-library). Tests and -instructions for a single repository are located in the -[Test Directory](./tests). - -## Contribute - -Thank you so much for considering to contribute. We are very happy, when somebody -is joining the hard work. Please fell free to open -[Bugs, Feature Requests](https://github.com/while-true-do/{{ WTD_REPO_NAME }}/issues) or -[Pull Requests](https://github.com/while-true-do/{{ WTD_REPO_NAME }}/pulls) after reading the [Contribution Guideline](https://github.com/while-true-do/doc-library/blob/master/docs/CONTRIBUTING.md). - -See who has contributed already in the [kudos.txt](./kudos.txt). - -## License - -This work is licensed under a [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause). - -## Contact - -- Site -- Twitter -- Code -- Mail [hello@while-true-do.io](mailto:hello@while-true-do.io) -- IRC [freenode, #while-true-do](https://webchat.freenode.net/?channels=while-true-do) -- Telegram diff --git a/templates/kudos.txt.j2 b/templates/kudos.txt.j2 deleted file mode 100644 index f8960a1..0000000 --- a/templates/kudos.txt.j2 +++ /dev/null @@ -1,27 +0,0 @@ -# kudos.txt - Express gratitude to your contributors. -# https://github.com/kudos-txt - -project: - - name: while-true-do.io - site: https://while-true-do.io - mail: hello@while-true-do.io - -contributors: - - name: - code: - home: , - mail: - role: - site: - work: , - -partners: - - name: kudos.txt - site: https://kudos-txt.io - - - name: - site: - -software: - - name: - site: