diff --git a/.github/ISSUE_TEMPLATE/new_concept_exercise_template.md b/.github/ISSUE_TEMPLATE/new_concept_exercise_template.md index 4defba60..4bcb4c08 100644 --- a/.github/ISSUE_TEMPLATE/new_concept_exercise_template.md +++ b/.github/ISSUE_TEMPLATE/new_concept_exercise_template.md @@ -1,12 +1,14 @@ --- -name: New Concept Exercise -about: Use this template for creating a new concept exericse issue. -title: "[V3]: Implement new Concept Exercise: " +name: "[ MAINTAINERS ] Implement New Concept Exercise" +about: Use this template to create an issue for implementing a new concept exericse. +title: "[V3]: Implement new Concept Exercise: " labels: "new exercise :sparkles:", help wanted +assignees: '' + --- -This issue describes how to implement the `` concept exercise for the python track. +This issue describes how to implement the `` concept exercise for the python track. @@ -32,65 +34,42 @@ Watching the following video is also helpful. It is a bit outdated, but is good This concept exercise is meant to teach an understanding/use of``. -[_Add additional detail here as needed_] +[replace this comment with additional detail for the Goal if needed. Otherwise just delete.] ## Learning objectives -[_Please list the learning objectives of this concept exercise here. See the below list for an example._] - - - ------**example** replace with this exericses' learning objectives. -------- +[_Please list the learning objectives of this concept exercise here. See the below list for an example. - understanding (_and using the concept_) that the `==` operator calls the dunder method `__eq__()` on a specific object, and uses that object's implementation for comparison. Where no implementation is present, the default `__eq__()` from _generic_ `object` is used. - the same applies for operators `<`, `<=`, `!=`, `>=`, `>` and correspondents dunder methods `__lt__`, `__le__`, `__ne__`, `__ge__`, `__gt__` - overriding the default implementation of the `__eq__()` dunder method on a specific object to customize comparison behavior. - overriding the default implementations of the `__lt__`, `__le__`, `__ne__`, `__ge__`, `__gt__` dunder methods on a specific object to customize comparison behavior. -- return the singleton `NotImplemented` if the called operation is not implemented - ----------------.-------------------------------------------------------------------------------- +- return the singleton `NotImplemented` if the called operation is not implemented] -##Out of scope +## Out of scope -[_Please list the concept considerations that will NOT be covered, and are out of scope. See the below list for an example._] - - - ------**example** please replace with this exercises' out of scope list. -------- - -- performance considerations - ----------------.-------------------------------------------------------------------------------- +[_Please list the concept considerations that will NOT be covered, and are out of scope. See the below list for an example. +- customizaton options +- performance considerations] ## Concepts -[_Please list the concepts/methods that will be included in the exercise. See the below list for an example._] - - - ------**example** please replace with this exercises' concepts list. -------- +[_Please list the concepts/methods that will be included in the exercise. See the below list for an example. - `__eq__`, `__lt__`, `__le__`, `__ne__`, `__ge__`, `__gt__` dunder methods - comparison behavior customization -- dunder methods override - ----------------.-------------------------------------------------------------------------------- - +- dunder methods override] ## Prerequisites -[_Please list the concepts the student needs to complete/understand before solving this exercise. See the below list for an example._] - - - ------**example** please replace with this exercises' prerequisites list. -------- +[_Please list the concepts the student needs to complete/understand before solving this exercise. See the below list for an example. - Method overriding - Comparison priority in Python @@ -103,15 +82,12 @@ This concept exercise is meant to teach an understanding/use of``. - `classes` - `numbers` - `sequences` -- `iteration` - ----------------.-------------------------------------------------------------------------------- - +- `iteration`] ## Resources to refer to -[_Below, list/link to resources that the exercise writer can use or consult in writing the exercise. This list is a suggestion to get them started writing._] +[_Below, list/link to resources that the exercise writer can use or consult in writing the exercise. This list is a suggestion to get them started writing.] @@ -123,7 +99,7 @@ This concept exercise is meant to teach an understanding/use of``. * ### Hints - ​ For more information on writing hints see [hints](https://github.com/exercism/docs/blob/main/anatomy/tracks/concept-exercises.md#file-docshintsmd) + For more information on writing hints see [hints](https://github.com/exercism/docs/blob/main/anatomy/tracks/concept-exercises.md#file-docshintsmd) * You can refer to one or more of the resources linked above, or analogous resources from a trusted source. We prefer using links within the [Python Docs](https://docs.python.org/3/) as the primary go-to, but other resources listed above are also good. @@ -132,7 +108,7 @@ This concept exercise is meant to teach an understanding/use of``. * ### `links.json` * The same resources can be used for the [ `concepts/links.json`](https://github.com/exercism/docs/blob/main/anatomy/tracks/concepts.md#file-linksjson) file, if it doesn't already exist. - * If there are particularly good/interesting informations sources for this concept that extend or supplement the concept exercise material, please add them to this document. + * If there are particularly good/interesting informations sources for this concept that extend or supplement the concept exercise material, please add them to the `links.json` document. @@ -141,7 +117,6 @@ This concept exercise is meant to teach an understanding/use of``. [_Link to the concept `about.md` file in the Concept section below. If the file still needs to be written, please link to the **GitHub issue** filed for the concept `about.md` file._] - Please see the following for more details on these files: [concepts](https://github.com/exercism/docs/blob/main/anatomy/tracks/concepts.md#file-linksjson) * ### Concept `about.md` @@ -152,13 +127,13 @@ Please see the following for more details on these files: [concepts](https://gi For more information, see [Exercise `introduction.md`](https://github.com/exercism/docs/blob/main/anatomy/tracks/concept-exercises.md#file-docsintroductionmd) -​ This should summarize the above document, with enough information for the student to complete the tasks in the concept exercise. + * This should summarize the above document, with enough information for the student to complete the tasks in the concept exercise. * ### Concept `introduction.md` For more information, see [Concept `introduction.md`](https://github.com/exercism/docs/blob/main/anatomy/tracks/concepts.md#file-introductionmd) -​ This should also be a summary of the above document, and will provide a brief introduction of the concept for a student who has **not yet** completed the concept exercise. + * This should also be a summary of the above document, and will provide a brief introduction of the concept for a student who has **not yet** completed the concept exercise. ## Test-runner