exercism / cpp

Exercism exercises in C++.
https://exercism.org/tracks/cpp
MIT License
259 stars 214 forks source link

Add key features #419

Closed ErikSchierboom closed 2 years ago

ErikSchierboom commented 3 years ago

This issue is part of the migration to v3. You can read full details about the various changes here.

In Exercism v3, each track must specify exactly six "key features". Exercism uses these features to highlight the most interesting, unique or "best" features of a language to a student.

Key features are specified in the top-level "key_features" field in the track's config.json file and are defined as an array of objects, as specified in the spec.

Goal

The "key_features" field in the config.json file should be updated to describe the six "key features" of this track. See the spec.

Example

{
  "key_features": [
    {
      "icon": "features-oop",
      "title": "Modern",
      "content": "C# is a modern, fast-evolving language."
    },
    {
      "icon": "features-strongly-typed",
      "title": "Cross-platform",
      "content": "C# runs on almost any platform and chipset."
    },
    {
      "icon": "features-functional",
      "title": "Multi-paradigm",
      "content": "C# is primarily an object-oriented language, but also has lots of functional features."
    },
    {
      "icon": "features-lazy",
      "title": "General purpose",
      "content": "C# can be used for a wide variety of workloads, like websites, console applications, and even games."
    },
    {
      "icon": "features-declarative",
      "title": "Tooling",
      "content": "C# has excellent tooling, with linting and advanced refactoring options built-in."
    },
    {
      "icon": "features-generic",
      "title": "Documentation",
      "content": "Documentation is excellent and exhaustive, making it easy to get started with C#."
    }
  ]
}

Tracking

https://github.com/exercism/v3-launch/issues/5

DSiekmeier commented 2 years ago

Hi everyone! If it is okay, I would like carry out this task.

ErikSchierboom commented 2 years ago

Great @DSiekmeier! I've assigned it to you. Feel free to look at some other tracks to get some inspiration.

A little warning in advance: the title's length must be <= 25 and the content's length <= 100. See https://github.com/exercism/docs/blob/main/building/tracks/config-json.md#key-features

DSiekmeier commented 2 years ago

Thank you very much, I will open a pull request soon.

Just to make it a little more comfortable: can you tell me where the icons are stored, so that one can decide which one to choose apart from judging by the name...?

ErikSchierboom commented 2 years ago

Yeah sure. See https://github.com/exercism/website-icons/tree/main/key-features