exercism / go

Exercism exercises in Go.
https://exercism.org/tracks/go
MIT License
978 stars 654 forks source link

Implement new Concept Exercise: Error Wrapping #1997

Open junedev opened 2 years ago

junedev commented 2 years ago

Getting Started

If you have not yet contributed to concept exercises before, this task requires some upfront reading to acquire the necessary background knowledge.

Here you can read about what Concept Exercises are and how they are structured:

Also be aware of these general guidelines.

Goal

The goal here is to create a new concept exercise that teaches error wrapping. That includes writing a concept and creating a new exercise.

Concepts

The following concept needs to be created. You can use the introduction.md file of the concept also as introduction.md file of the exercise. No need to create different content at this point. Additionally, if you want to save some time it is ok to not have an extensive about.md at this point. It can also be mainly the instruction.md content, maybe with some additions you would like to make.

Learning Objectives

In the concepts the student should learn about the following topics and then practice them in the concept exercise.

The about.md file could additionally mention ...

We could potentially add some other advanced error topics if there are ideas.

Out of Scope

Prerequisites

Other prerequisites should be added as needed to solve the specific exercise.

Story Idea

There is probably no exercise that can be ported directly because Go's error handling is so special but here are some error related exercises from other tracks. The story could maybe be re-used even if we need to change the actual tasks.

Resources

Here some links that might be helpful as a starting point and/or for the links section of the concept:

Implementation Notes

How to proceed

  1. First accept this issue by saying "I'd like to work on this" (no need to wait for a response, just go ahead).
  2. Use this issue to discuss any questions you have, what should be included in the content and what not and to collect more reference material.
  3. Create a PR and set "exercism/go" as reviewers. Additionally you can write in #maintaining-go on Slack that your PR is ready for review. Once you incorporated any critical feedback that the reviewer might give you and the PR is approved, it will be merged by a maintainer.
telemachus commented 2 years ago

Two notes (per #2013)

  1. When this lesson is done, the original errors lesson should be edited to include a forward reference to this lesson for more details about errors.
  2. This lesson should include a note that errors.Is is recommended instead of == unless there is a specific reason not to unwrap the error.

See #2013 for background discussion.

junedev commented 2 years ago

Putting this on hold because of https://github.com/exercism/go/issues/2492.