Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add key features #419

Closed
Tracked by #427
ErikSchierboom opened this issue Jan 29, 2021 · 4 comments
Closed
Tracked by #427

Add key features #419

ErikSchierboom opened this issue Jan 29, 2021 · 4 comments
Assignees
Labels
x:action/create Work on something from scratch x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)

Comments

@ErikSchierboom
Copy link
Member

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

exercism/v3-launch#5

@ErikSchierboom ErikSchierboom changed the title [v3] Add key features Add key features Aug 17, 2021
@ErikSchierboom ErikSchierboom added x:action/create Work on something from scratch x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:type/content Work on content (e.g. exercises, concepts) labels Aug 18, 2021
@DSiekmeier
Copy link
Contributor

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

@ErikSchierboom ErikSchierboom added the x:status/claimed Someone is working on this issue label Nov 17, 2021
@ErikSchierboom
Copy link
Member Author

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
Copy link
Contributor

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
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/create Work on something from scratch x:knowledge/none No existing Exercism knowledge required x:size/small Small amount of work x:status/claimed Someone is working on this issue x:type/content Work on content (e.g. exercises, concepts)
Projects
None yet
Development

No branches or pull requests

3 participants