Git Product home page Git Product logo

kata-log's Introduction

Kata-Log

Resources to facilitate coding katas

Go to http://kata-log.rocks/ to see it in all its glory...

How to collaborate with a new kata

  1. Fork this repository
  2. Clone the new repository in your local environment
  3. Create a branch
  4. Add a new file:
_katas/name-of-the-kata.md

with this content (see details later):

---
layout: post
title:  "The name of the kata"
categories: [ List of categories separated by commas ]
image: default.jpg
---

{% include credits.md name='Author name' url='Original kata URL' %}

## Name of the kata

General explanation.

(*) Starting point
  1. Create a pull request

Name of the kata

Replace The name of the kata.

For example:

---
...
title: "Gilded Rose Kata"
...
---

Categories

Replace List of categories separated by commas by one level and one or more topics:

  • Level. Choose Starter or Experienced.
  • Topics. Choose as many as required from this list: SOLID Principles, Mocks, TDD, Software-Design, Golden Master, SOLID Principles, Outside-In, Agile, Pair-Programming, Mocks, BDD, Refactoring.

For example:

---
...
categories: [Starter, Refactoring, Golden Master, SOLID Principles, Software-Design]
...
---

Image

If you have an available image to represent this kata, add it into images directories and replace default.jpg by the new filename in the header:

---
...
image: default.jpg
---

Credits

Give credit to the author of the kata when adding:

{% include credits.md name='Author name' url='Original kata URL' %}

For example:

{% include credits.md name='Emily Bache' url='https://github.com/emilybache/GildedRose-Refactoring-Kata' %}

Then, a Credits section will appear in the page.

The starting point

Initial source code is required to do the kata

If there is initial source code for the kata (for example, a refactoring kata) add this content at the end of the file (instead of (*) Starting point) to indicate the location (URL) and languages:

{%
    include get_the_code.md
    url='Source code repository URL'
    languages='List of languages separated by commas'
%}

For example:

{%
    include get_the_code.md
    url='https://github.com/emilybache/GildedRose-Refactoring-Kata'
    languages='ABAP, C, C++, C#, Dart, Elixir, F#, Go, Groovy, Haskell,
    Java, JavaScript, Kotlin, Perl, PHP, PLSQL, Python, Ruby, Rust, R,
    Scala, Smalltalk, Swift'
%}

Initial source code is not required to do the kata

In case there is no initial source code for the kata, add this line at the end of the file (instead of (*) Starting point) to add repository links with bootstraps in different programming languages:

{% include starting_points.md %}

kata-log's People

Contributors

aurelian avatar dependabot[bot] avatar drpicox avatar egga avatar egga-zz avatar eggstrema avatar jukecraft avatar martinsson avatar rachelcarmena avatar rradczewski avatar steven-solomon avatar thinkingbox avatar waterlink avatar wolframkriesing avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.