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

glossary: new update #123

Merged
merged 14 commits into from
Aug 17, 2020
66 changes: 52 additions & 14 deletions data/glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,16 @@
url: https://www.codewars.com/collections

- term: Console
description: Synonym for "output panel" (see below).
description: See [output panel](/glossary/#output-panel-id)

- term: Contributor(s)
description: User(s) who have either authored, approved, translated or modified a kata in any way (a list of them can be seen in the "Details" page of any kata.

- term: Dan
description: 段
description: |
(段) - The term is borrowed from a system in Japanese martial arts, which is in turn borrowed from the game of Go.
Dan indicates the number of degrees in master level. This is why they count upward.
see: /concepts/gamification/ranks/
links:
- title: Dan (rank) - Wikipedia
url: https://en.wikipedia.org/wiki/Dan_(rank)
Expand All @@ -94,6 +97,14 @@
description: |
Initial state of a new born kata: when you create a new kata, it is in Draft mode as long as it is not "published". Kata in draft state are not visible through the [katas search page](https://www.codewars.com/kata/my-languages), but can be accessed and tried by other users if the author gives them the direct link to the trainer. Note that a kata in draft state cannot be completed (eg. "submit final" will not show up if you pass all the tests of a draft).

- term: Duplicates (Kata)
description: |
Kata may be considered as duplicates in the following situations, for example:
- another Kata is already published (currently in beta or approved) asking for nearly the same thing(s)
- other Kata already exist about the same topic which has been covered already a lot (like, "yet another fizz buzz thing...")

The usual course of action for an author being told his kata is a duplicate is to unpublish his kata, if he cannot make it different/valuable enough compared to what's already present in the database.

- term: Edit panel
description: |
This is the interface an author uses to create or modify a kata. There you can see all the available languages, author's solution, initial solution, all the tests, the preloaded version and the description. Contributors and some power users (in specific conditions) have access to the edit panel of published katas.
Expand All @@ -102,11 +113,13 @@
* Translating a kata has to be done through the creation of a translation, and ___never___ directly through the edit panel (unless you're the author, but even then, you are advise to use translations)

- term: Example tests
id: example-tests-id
description: |
Tests that are visible to the user in the trainer. Most of the time, they are only a tiny part of the full tests suite. Hence, passing all the tests of the example tests doesn't make you pass the kata. You have to use `ATTEMPT`.
You run the example tests using the `TEST` button in the trainer.

- term: Fixed tests
id: fixed-tests-id
description: |
Tests whose inputs/outputs are always the same, each time your run the tests. Generally, the example tests are made of those, and the test cases contains both fixed and random tests.

Expand All @@ -131,12 +144,14 @@
- term: Honor (points)
description: |
Honor points are the score that is showing up in the top right corner, aside of your avatar. You can win honor points in different ways (completing katas, up votes on your comments or solutions, translations, creating katas, ...)
see: /gamification/honor/

- term: Inactive (author)
description: |
Author of a kata who hasn't been connected for more than 30 days. When an author is inactive, some actions he's normally the only person allowed to do are doable by other people (power users with the required privilegees).

- term: Initial solution
id: initial-solution-id
description: |
This is the starting point of your code when you enter the trainer of a kata (the "Solution" box).

Expand All @@ -146,14 +161,16 @@
Note that the `Issue` label is ___NOT___ to use for a user who doesn't understand why his solution is failing some (or all) the tests of the kata.

- term: Kata
description: 型
description: |
"Kata" (型) is how coding tasks are named on Codewars. See [here - TODO]() for more information about it.

- term: Kata search page
description: |
This is the page on Codewars where you can search for specific Kata by name, rank, language, ...
See [TODO]() for more explanations.
links:
- title: CodeKata by Dave Thomas
url: http://codekata.com/kata/codekata-intro/
- title: Kata (programming) - Wikipedia
url: https://en.wikipedia.org/wiki/Kata_(programming)
- title: Kata - Wikipedia
url: https://en.wikipedia.org/wiki/Kata
- title: Kata search page on Codewars
url: https://www.codewars.com/kata/my-languages

- term: Kumite
description: 組手
Expand All @@ -162,7 +179,10 @@
url: https://en.wikipedia.org/wiki/Kumite

- term: Kyū
description: 級
description: |
(級) - The term is borrowed from a system in Japanese martial arts, which is in turn borrowed from the game of Go.
Kyu (or Kyū) indicates the number of degrees away from master level (Dan). This is why they count downward.
see: /gamification/ranks/
links:
- title: Kyū - Wikipedia
url: https://en.wikipedia.org/wiki/Ky%C5%AB
Expand All @@ -186,6 +206,7 @@
- term: Markdowns (formatting)
description: |
Codewars is responsive to `markdowns`. They allow you to format code, descriptions or comments so that thay are properly readable for other users.
see: /references/markdown/

- term: Merge conflicts
description: |
Expand All @@ -199,6 +220,12 @@
Nowadays, most test suites are written in a way that avoids this kind of problem but typically, if you end up passing the fixed tests but failing all the random tests with something along the line of `[your result] should equal []`, you're most likely facing a "mutation of the input" problem.
Hence... Don't mutate the input.

- term: Output panel
id: output-panel-id
description: |
The output panel is the tab in the trainer where the tests feedback and all that you print to the console from inside your code are written to. It's actually the usual `STDOUT/STDERR`.
It's useful for [debugging - TODO]() too.

- term: Preloaded (code/section)
description: |
In a Kata, the preloaded section is code that is executed _before_ the solution of the user is defined. The code hold by this section isn't visible to the user but every function or variable defined there is accessible to him drugint the executions of his code.
Expand All @@ -207,6 +234,7 @@
- term: Progress
description: |
Aside of honor points, you gain "progress" by completing Kata (and only that way). Progess is what is conditioning your current rank as a codewarrior.
see: /concepts/gamification/ranks/

- term: Publishing (kata)
description: When you hit "publish" in the edit panel of a kata you created, it enters the beta process and becomes visible to anyone in the [katas search page](https://www.codewars.com/kata/my-languages). The beta process begins at the moment a kata is published.
Expand All @@ -217,6 +245,7 @@
Most of the times, the user (you) is actually missing something, so use the Question label and not the Issue label, unless you can ___prove___ that the problem you're facing is actually an "issue".

- term: Random tests
id: random-tests-id
description: |
Tests whose the inputs/outputs aren't the same each time you run the test suite.
Random tests are prefered to randomized tests, when creating Kata.
Expand All @@ -238,8 +267,7 @@
A retired Kata is a Kata that has been judge not qualitative enough by other codewarriors during the beta process. It has been removed from the beta process after some critical thresholds have been reached, without any action of the author. Nothing can be done anymore with a retired Kata.

- term: Sample tests
description: |
See example tests.
description: See [example tests](/glossary/#example-tests-id)

- term: Satisfaction rating
description: |
Expand All @@ -250,8 +278,7 @@
Another name used for the author of a kata.

- term: Solution setup
description: |
See initial solution.
description: See [initial solution](/glossary/#initial-solution-id).

- term: Submit/Submit final
description: |
Expand All @@ -261,6 +288,12 @@
description: |
Label used in the discourses section of Kata to suggest non critical improvements to it (like rewording some parts of the description, or the feedback of some assertion messages in the tests), or to announce the pulication of a translation (useful when the author is inactive, so that power users can review and approve the translation).

- term: Test cases
id: test-cases-id
description: |
Test cases represent the full batch of tests the code of a user has to pass to complete a Kata on Codewars.
Test cases generally contain more tests than the [example tests](/glossary/#example-tests-id), combining both [fixed](/glossary/#fixed-tests-id) and [random tests](/glossary/#random-tests-id).

- term: Test Driven Development
description: |
Kata are built following this principle: you are provided with specifications and a set of tests, and your goal is to pass those tests (by following the specifications or finding a way to at least pass the tests).
Expand All @@ -269,13 +302,18 @@
- title: Test-driven Development - Wikipedia
url: https://en.wikipedia.org/wiki/Test-driven_development

- term: Test suite (kata)
description: See [test cases](/glossary/#test-cases-id)

- term: Trainer (kata)
description: |
This is the place where you write your code to complete a task.
see: /getting-started/solving-kata/

- term: Trainer suggestions
description: |
Trainer suggestions are the Kata that are showing up at the top of the dashboard. Those suggestions can be tweaked at some point, either through the profile of the user or directly through the dashboard.
See [training setup](/getting-started/setting-up/#training-setup).

- term: Translation
description: |
Expand Down