kudos-txt/kudos.txt

Express gratitude to your contributors.

kudos.txt's Issues

Explain the format

As a user / contributor, I need to understand the format in detail and should get an explanation in the README.md.

• Update descrtiption section
• Update usage section

Feature: website needed

As a user/contributor, I want to get information on a website, presented in a nice way.

Feature: helper scripts

As a user/contributor, I want to facilitate the human/machine readability of kudos. Some examples for bash, js, etc would be awesome.

Feature: new fields

Suggestion for:

contributor / partner:

• type -> to identify the type of partnership / contribution
• code -> to identify where to find code

Feature: KUDOS.txt

Most META Files in a repository are named in these 2 ways:

• .xxxx -> for technical files like lint-rules
• XXXXX.yy -> for Human Files like README or LICENSE

We should follow this convention

Update url, mail and more

As a user, I want to see the own domains and mails reflected in all places. while-true-do should be referenced in the kudos.txt or README as a partner.

Feature: Additional entries

Additonal entry ideas:

A new entry for chat.

contributors
  - name:
    chat: <service | nick >, <service | nick>
    chat: Bob | telegram, Bobby | skype

A new entry for blog.

contributors
  - name:
    blog: <url>

Partners should get the mail option. Maybe chat, too.

partners:
  - name: <name of the partner>
    mail: <mail address>
    chat: <service | nick >, <service | nick>

Project, Partners and maybe everybody should get the help option to provide support channels.

partners:
  - name: <name of the partner>
    help: <mail address> | <support form> | <support channel>

Some of the options should be generally available.

bug: typo in contributors > home

currently:

contributors:
- name: <name of the contributor>
  home: <country>, <zip>, <country>

should be:

- name: <name of the contributor>
  home: <country>, <region>, <town>, <zip>, <street>

kudos.txt

As a contributor/user, I want to see the kudos.txt reflecting the format of src/kudos.txt

Updates for README.md

As a user, I want to get advanced and project specific information in the README.
Currently the standard format of while-true-do.io is used and should be refactored to present kudos-txt as a standalone project / subproject.

• Clear description of features
• description of the standard itself
• pictures and idea how to use kudos-txt
• integration of "FAQ"