This article contains a set of guidelines, which can be used by authors to create good, enjoyable, high-quality kata. They were collected to help ensure that kata are of sufficient quality and users' experience will be as good as possible.
- Avoid creating blatant duplicates, and use the idea which has not yet been widely used to create a kata. Note that with so many existing kata, this can be very challenging to achieve, because it's very difficult to find out if your idea has already been used or not. Remember that you can always ask more experienced users if your idea is worthy of creating a new kata, or maybe it has been already exploited sufficiently. Make sure your kata adds some new value to Codewars.
Task and Requirements
- Requirements and design should hold to generally accepted and widely recognized guidelines related to software design, programming, and domain of the kata. Do not require users to do things in a way that is widely recognized as wrong. If any of these guidelines are broken, the description should justify it with a plausible explanation.
- Keep kata focused on one task. Avoid distractions, do not add other, smaller, "side" requirements that do not add too much value to the task itself. Additional "steps" required to solve the task usually do not make the kata more interesting, but are rather seen as tedious and distracting. While things like validation of the input, parsing or stringification, filtering of invalid elements, etc. can be a part of some kata related to specific topics (for example, parsers or interpreters), usually they are just additional nuisance a user has to struggle with, and do not add too much value to the task.
- Make requirements very clear. If the kata is not a puzzle, describe everything that will be tested and leave no surprises. The reason for every failing test case should be evidently visible in the description of the kata.
- Use ideas that can be easily translated, if they are not the main point of the kata. It is generally OK to use code constructs idiomatic for the language of the author's choice, but be aware when such idioms can cause problems to translators. Sooner or later someone will translate the kata to another programming language, and if the translator is not able to efficiently handle the original, idiomatic approach, the quality or consistency of the translation can suffer.
- Do not use requirements which cannot be reliably tested, enforced, or expressed in terms of a kata. Some requirements simply do not translate well into a kata, and code restrictions ("Do not use X", or "You have to use Y") is one example of such.
- All components of a kata, its description and code snippets, have dedicated sets of authoring guidelines that should be followed.
- Kata should be complete. There should be no excuses of "I did not know how to do [something]" or "I will add [something] later". Published kata should be complete and ready to be solved and reviewed. If you do not know how to do something, keep the kata as a draft and ask others for help.
- Ask other users for feedback and for help when needed. Codewars community is very helpful and will gladly drive you in a direction of improvements and better quality. After all, it's them who will solve the kata after it gets published.
#help-authorchannel on Discord to ask for feedback on your ideas or get help with any problems you encounter.
- You can share links to the draft of your kata before publishing, to get early feedback on its quality.
- You are responsible for your kata. As long as you're an active Codewars user, you should address quality issues in kata you authored: fix issues, consider suggestions, answer questions. See kata curation guidelines for more guidelines on kata maintenance.