-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
91 lines (69 loc) · 4.67 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>Kata Seeds by kata-seeds</title>
</head>
<body>
<div id="container">
<div class="inner">
<header>
<h1>Kata Seeds</h1>
<h2>Ready-to-go projects to help you get started quickly with a code exercise</h2>
</header>
<section id="downloads" class="clearfix">
<a href="https://github.com/kata-seeds" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>
<hr>
<section id="main_content">
<p>See the full list of Kata Seeds at <a href="https://github.com/kata-seeds">github.com/kata-seeds</a></p>
<h2>
<a id="tips-for-making-a-kata-seed" class="anchor" href="#tips-for-making-a-kata-seed" aria-hidden="true"><span class="octicon octicon-link"></span></a>Tips for making a Kata Seed</h2>
<h3>
<a id="use-the-template" class="anchor" href="#use-the-template" aria-hidden="true"><span class="octicon octicon-link"></span></a>Use the template</h3>
<p>Copy <a href="https://github.com/kata-seeds/kata-seed-template">kata-seed-template</a> (don't fork it) and start from there. If there's something you think would benefit all Kata Seeds, open a pull request on the template.</p>
<h3>
<a id="name-your-kata-seed" class="anchor" href="#name-your-kata-seed" aria-hidden="true"><span class="octicon octicon-link"></span></a>Name your Kata Seed</h3>
<p>If you're only using the core language and standard library, the name should be <code>language-seed</code>. If you have to use/install a dependency to run the tests, the name should be <code>language-framework-seed</code> instead.</p>
<h3>
<a id="write-the-code" class="anchor" href="#write-the-code" aria-hidden="true"><span class="octicon octicon-link"></span></a>Write the code</h3>
<p>The code in the seed should implement a simple way to greet a person, plus a test that it works. Implement that functionality in whatever way is most natural in your language. To get an idea of how small the implementation should be, you should read the implementations in a few seeds that use similar languages to yours.</p>
<h3>
<a id="just-run-make" class="anchor" href="#just-run-make" aria-hidden="true"><span class="octicon octicon-link"></span></a>Just run <code>make</code>
</h3>
<p>Makefiles are executable documentation. Someone can run <code>make</code> to run the tests, but also read the <code>Makefile</code> and see how the tests are run and dependencies are installed.</p>
<p>Try your best to ensure someone can run <code>make</code> and get the tests running. The less someone has to do to get up and running, the more time they can spend learning the language instead of the tooling.</p>
<p>Ideally, the behavior would be:</p>
<ul>
<li>Run <code>make</code> the first time: Dependencies are installed, and the tests run.</li>
<li>Run <code>make</code> subsequent times: Dependencies are checked, and the tests run. The dependency checking should be near-instantaneous.</li>
</ul>
<h3>
<a id="commit-exact-dependency-versions" class="anchor" href="#commit-exact-dependency-versions" aria-hidden="true"><span class="octicon octicon-link"></span></a>Commit exact dependency versions</h3>
<p>The last thing someone wants to deal with when practicing a kata is bugs in dependencies. Pin the the dependencies to exact versions, or commit a dependency lock file if your language has one.</p>
</section>
<footer>
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.
</footer>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-59852558-1");
pageTracker._trackPageview();
} catch(err) {}
</script>
</div>
</div>
</body>
</html>