mirror of
https://github.com/MedUnes/go-kata.git
synced 2026-03-12 21:55:53 +07:00
init commit
This commit is contained in:
30
README_TEMPLATE.md
Normal file
30
README_TEMPLATE.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Kata [ID]: [Title of the Challenge]
|
||||
|
||||
**Target Idioms:** [e.g. Concurrency Patterns, Interface Pollution, Error Wrapping]
|
||||
**Difficulty:** [🟢 Beginner / 🟡 Intermediate / 🔴 Advanced]
|
||||
|
||||
## 🧠 The "Why"
|
||||
*Briefly explain the mismatch seasoned devs would face here. Why would the "Java way" or "Python way" fail in Go for this specific problem?*
|
||||
|
||||
## 🎯 The Scenario
|
||||
*[Describe a realistic production problem. Example: "You are building a CLI that parses 1GB logs..."]*
|
||||
|
||||
## 🛠 The Challenge
|
||||
Implement a solution that satisfies the following requirements.
|
||||
|
||||
### 1. Functional Requirements
|
||||
* [ ] [Requirement A]
|
||||
* [ ] [Requirement B]
|
||||
|
||||
### 2. The "Idiomatic" Constraints (Pass/Fail Criteria)
|
||||
*To pass this kata, you **must** use the following patterns:*
|
||||
* [ ] **Constraint 1:** [e.g. Do not allocate new memory inside the loop.]
|
||||
* [ ] **Constraint 2:** [e.g. Use `functional options` for configuration.]
|
||||
* [ ] **Constraint 3:** [e.g. Return wrapped errors.]
|
||||
|
||||
## 🧪 Self-Correction (Test Yourself)
|
||||
* **If you did X:** [Explain why this is "un-idiomatic" or dangerous in Go]
|
||||
* **Instead, ensure Y:** [Explain the idiomatic fix]
|
||||
|
||||
## 📚 Resources
|
||||
* [Link to Go Blog or Spec]
|
||||
Reference in New Issue
Block a user