Skip to content

Commit 0704599

Browse files
Update HELLO.md (#932)
1 parent 4ba365c commit 0704599

File tree

1 file changed

+19
-46
lines changed

1 file changed

+19
-46
lines changed

HELLO.md

+19-46
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you have any questions, if you're unsure where to start or you're stuck, do n
1010

1111
## Tasks
1212

13-
### 1. Create, improve, and review concepts and concept exercises for v3
13+
### 1. Create, improve, and review concepts and concept exercises
1414

1515
Check open issues and PRs in this repository [tagged with the concept-exercise label](https://github.com/exercism/elixir/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3Aconcept-exercise) to see which concepts need a new exercise or an improvement.
1616

@@ -30,25 +30,16 @@ One-time ~1h investment to learn how a concept exercise is structured, and then
3030

3131
#### Useful links for this task
3232

33-
- [Open issues and PRs for Elixir for v3](https://github.com/exercism/elixir/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3Av3)
34-
- [V3 Elixir concept exercises](https://github.com/exercism/elixir/tree/master/exercises/concept)
35-
- [V3 Elixir concepts](https://github.com/exercism/elixir/tree/master/concepts)
36-
- [V3 staging](https://exercism.lol/)
37-
- [The features of v3](https://github.com/exercism/v3/blob/master/docs/features-of-v3.md)
38-
- [Rationale for v3](https://github.com/exercism/v3/blob/master/docs/rationale-for-v3.md)
39-
- [What are concept exercise and how they are structured?](https://github.com/exercism/docs/blob/main/anatomy/tracks/concept-exercises.md)
33+
- [Open issues for concepts and concept exercises](https://github.com/exercism/elixir/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3Ax%3Amodule%2Fconcept-exercise%2Cx%3Amodule%2Fconcept)
34+
- [Concept exercises docs](https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md)
4035

41-
### 2. Create an analyzer for a v3 concept exercise
36+
### 2. Create or improve an analyzer for a concept exercise
4237

4338
An analyzer is a tool that analyzes the AST of an exercise solution looking for specific features. Based on the results, it can leave helpful comments for the student.
4439

45-
Some v3 concept exercises must have an analyzer. They won't be mentored, and their goal is to teach how to use specific features of the language, so we need to look out for solutions that pass the tests, but don't use the taught features.
40+
Some concept exercises must have an analyzer. Their goal is to teach how to use specific features of the language, so we need to look out for solutions that pass the tests, but don't use the taught features.
4641

47-
You will recognize the exercises that need an analyzer by their `design.md` file containing an "analyzer" section that outlines what features of a desired solution need to be checked for
48-
([example](https://github.com/exercism/elixir/blob/4e18d2385066e46de5ee5ea3e1ba9ce0caffdfa5/exercises/concept/boutique-inventory/.meta/design.md#L29-L34))
49-
.
50-
51-
You can choose any exercise that doesn't already have an analyzer and try to implement one.
42+
See [the list of open analyzer issues](https://github.com/exercism/elixir-analyzer/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
5243

5344
This task isn't as difficult as it might sound! We already have the tool for this job. It's all about using it to describe the desired features of a good solution. See the example PR in links.
5445

@@ -59,22 +50,21 @@ Everyone that has interest in the Elixir programming language. Concept exercises
5950
#### Time investment
6051

6152
One-time ~30 min investment to get familiar with how existing analyzers are written and the concept exercise in
62-
question, and then ~1-2h for writing the analyzer.
53+
question, and then ~30-60 min for writing the analyzer.
6354

6455
#### Useful links for this task
6556

66-
- [What is an analyzer?](https://github.com/exercism/docs/tree/main/anatomy/track-tooling/analyzers)
67-
- [V3 Elixir concept exercises](https://github.com/exercism/elixir/tree/master/exercises/concept)
68-
- [Currently implemented analyzers](https://github.com/exercism/elixir-analyzer/tree/main/lib/test_suite)
57+
- [What is an analyzer?](https://github.com/exercism/docs/tree/main/building/tooling/analyzers)
6958
- [How to write an analyzer?](https://github.com/exercism/elixir-analyzer/blob/master/docs/writing-an-analyzer.md)
59+
- [Analyzer recipes](https://github.com/exercism/elixir-analyzer/blob/main/docs/recipes.md)
60+
- [Open analyzer issues](https://github.com/exercism/elixir-analyzer/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
7061
- [Example PR adding an analyzer for the pacman-rules exercise](https://github.com/exercism/elixir-analyzer/pull/30/files)
62+
- [Currently implemented analyzers](https://github.com/exercism/elixir-analyzer/tree/main/lib/elixir_analyzer/test_suite)
7163
- [Elixir's automated comments](https://github.com/exercism/website-copy/tree/main/analyzer-comments/elixir)
7264

7365
### 3. Check open issues and PRs in other repos
7466

75-
To launch v3, we need a well-working analyzer, test runner, and representer. All of those projects are already created and functional, but they might still need some improvements.
76-
77-
V3 is our current focus, but really don't want to get involved with it at the moment, you can also check if the current Elixir track has open issues or PRs that could benefit from more attention.
67+
Browse all the open issues in all the Elixir track repositories and choose something that sounds interesting! If an issue is tagged with "help wanted", that means it's well suited for all contributors interested in helping out. Issues without this label are meant for the regular track maintainers.
7868

7969
#### Who is this task well-suited for?
8070

@@ -86,7 +76,7 @@ Anything from 15 minutes to many hours, depending on the specific issue.
8676

8777
#### Useful links for this task
8878

89-
- [What is track tooling?](https://github.com/exercism/docs/tree/main/anatomy/track-tooling#track-tooling)
79+
- [What is track tooling?](https://github.com/exercism/docs/tree/main/building/tooling)
9080
- [Open issues and PRs in the Elixir analyzer](https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-analyzer)
9181
- [Open issues and PRs in the Elixir test runner](https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-test-runner)
9282
- [Open issues and PRs in the Elixir representer](https://github.com/pulls?q=is%3Aopen+repo%3Aexercism%2Felixir-representer)
@@ -98,6 +88,8 @@ Anything from 15 minutes to many hours, depending on the specific issue.
9888

9989
Almost all existing practice exercises could use an analyzer. It would decrease the work load of the mentors.
10090

91+
There are no open issues for this type of task, but it can still be worked on.
92+
10193
#### Who is this task well-suited for?
10294

10395
People that already have some experience mentoring the specific Elixir exercise. Writing an analyzer well requires anticipating a lot of different approaches to the same exercise.
@@ -108,29 +100,10 @@ One-time ~30 min investment to get familiar with how existing analyzers are writ
108100

109101
#### Useful links for this task
110102

111-
- [What is an analyzer?](https://github.com/exercism/docs/tree/main/anatomy/track-tooling/analyzers)
112-
- [Currently implemented analyzers](https://github.com/exercism/elixir-analyzer/tree/main/lib/test_suite)
103+
- [What is an analyzer?](https://github.com/exercism/docs/tree/main/building/tooling/analyzers)
113104
- [How to write an analyzer?](https://github.com/exercism/elixir-analyzer/blob/master/docs/writing-an-analyzer.md)
114-
- [Two-fer analyzer](https://github.com/exercism/elixir-analyzer/blob/65832211726bc04b4b35a1840ed55bbb67b4cae2/lib/test_suite/two_fer.ex)
105+
- [Analyzer recipes](https://github.com/exercism/elixir-analyzer/blob/main/docs/recipes.md)
106+
- [Two-fer analyzer](https://github.com/exercism/elixir-analyzer/blob/deb8f57342a797361af4be604f31dc09f550f79e/lib/elixir_analyzer/test_suite/two_fer.ex)
107+
- [Currently implemented analyzers](https://github.com/exercism/elixir-analyzer/tree/main/lib/elixir_analyzer/test_suite)
115108
- [Elixir's automated comments](https://github.com/exercism/website-copy/tree/main/analyzer-comments/elixir)
116109
- [General Exercism docs](https://github.com/exercism/docs)
117-
118-
### 5. Port a new practice exercise from problem specifications
119-
120-
There are still a few practice exercises on the platform that the Elixir track hasn't implemented yet. You can find one in the problems specification repo and port it to Elixir.
121-
122-
#### Who is this task well-suited for?
123-
124-
People that already have some experience maintaining the Elixir track.
125-
126-
#### Time investment
127-
128-
A few hours.
129-
130-
#### Useful links for this task
131-
132-
- [Existing Elixir practice exercises](https://github.com/exercism/elixir/tree/master/exercises/practice)
133-
- [Problem specifications repo](https://github.com/exercism/problem-specifications)
134-
- [Porting an Exercise to Another Language Track](https://github.com/exercism/legacy-docs/blob/main/you-can-help/implement-an-exercise-from-specification.md)
135-
- [Elixir's CONTRIBUTING.md](https://github.com/exercism/elixir/blob/master/CONTRIBUTING.md)
136-
- [General Exercism docs](https://github.com/exercism/docs)

0 commit comments

Comments
 (0)