Learn Go with tests
Contribute on github
Search…
main
Learn Go with Tests
Go fundamentals
Install Go
Hello, World
Integers
Iteration
Arrays and slices
Structs, methods & interfaces
Pointers & errors
Maps
Dependency Injection
Mocking
Concurrency
Select
Reflection
Sync
Context
Intro to property based tests
Maths
Reading files
Templating
Generics
Revisiting arrays and slices with generics
Testing fundamentals
Introduction to acceptance tests
Build an application
Intro
HTTP server
JSON, routing and embedding
IO and sorting
Command line & package structure
Time
WebSockets
Questions and answers
OS Exec
Error types
Context-aware Reader
Revisiting HTTP Handlers
Meta
Why unit tests and how to make them work for you
Anti-patterns
Contributing
Chapter Template
Powered By GitBook
Contributing
Contributions are very welcome. I hope for this to become a great home for guides of how to learn Go by writing tests. Consider submitting a PR or creating an issue which you can do here.

What we're looking for

  • Teaching Go features (e.g things like if, select, structs, methods, etc).
  • Showcase interesting functionality within the standard library. Show off how easy it is to TDD a HTTP server for instance.
  • Show how Go's tooling, like benchmarking, race detectors, etc can help you arrive at great software.
If you don't feel confident to submit your own guide, submitting an issue for something you want to learn is still a valuable contribution.

⚠️ Get feedback quickly for new content ⚠️

  • TDD teaches us to work iteratively and get feedback and I strongly suggest you do the same if you wish to contribute
    • Open a PR with your first test and implementation, discuss your approach so I can offer feedback and course correct
  • This is of course open-source but I do have strong opinions on the content. The sooner you talk to me the better.

Style guide

  • Always be reinforcing the TDD cycle. Take a look at the Chapter Template.
  • Emphasis on iterating over functionality driven by tests. The Hello, world example works well because we gradually make it more sophisticated and learning new techniques driven by the tests. For example:
    • Hello() <- how to write functions, return types.
    • Hello(name string) <- arguments, constants.
    • Hello(name string) <- default to "world" using if.
    • Hello(name, language string) <- switch.
  • Try and minimise the surface area of required knowledge.
    • Thinking of examples that showcase what you're trying to teach without confusing the reader with other features is important.
    • For example you can learn about structs without understanding pointers.
    • Brevity is king.
  • Follow the Code Review Comments style guide. It's important for a consistent style across all the sections.
  • Your section should have a runnable application at the end (e.g package main with a main func) so users can see it in action and play with it.
  • All tests should pass.
  • Run ./build.sh before raising PR.
Meta - Previous
Anti-patterns
Next - Meta
Chapter Template
Last modified 6mo ago
Copy link
Outline
What we're looking for
⚠️ Get feedback quickly for new content ⚠️
Style guide