[Recurring] Keep exercises up to date with problem specifications
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- elixir
- 領域
- documentation, testing, tooling
調査の方向性
./bin/fetch_configlet と ./bin/configlet sync から始めて、同期されていない演習を特定します。CONTRIBUTING.md と exercises/practice//.meta/design.md を読み、その後、影響を受けるドキュメント、メタデータ、tests.toml、canonical-data.json、Elixir のテストファイルを調べます。選択した演習が問題の仕様に一致し、./bin/test_exercises.sh が成功すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
This is a recurring task that has to be done from time to time. Do not reference this issue by writing resolves/fixes #XXX in your PR because that will close it.
We want to keep the track up to date with problem specifications, which means regularly checking if anything changes and needs updating.
How to do this task:
Step 1: fetch configlet
Run:
./bin/fetch_configlet
Step 2: check which exercises need updating and in which way
Run:
./bin/configlet sync
The output will list all Elixir exercises that are out of sync in some way. Example output:
[warn] docs: instructions unsynced: affine-cipher
[warn] docs: instructions unsynced: all-your-base
[warn] metadata: unsynced: acronym
[warn] metadata: unsynced: armstrong-numbers
[warn] collatz-conjecture: missing 2 test cases
- zero is an error (2187673d-77d6-4543-975e-66df6c50e2da)
- negative value is an error (ec11f479-56bc-47fd-a434-bcd7a31a7a2e)
Choose one or more problems and attempt to fix it. Metadata and doc updates can be all done together for many exercises in a single PR, but please create separate PRs per exercise when changing tests.
Step 3.1: Sync all docs
Run this command to update all exercise docs (introductions):
./bin/configlet sync --docs --update
Press y when asked sync the above docs ([y]es/[n]o)?.
Step 3.2: Sync all metadata
Run this command to update all exercise metadata:
./bin/configlet sync --metadata --update
Press y when asked sync the above metadata ([y]es/[n]o)?.
Step 3.3: Update tests for an exercise
The general goal is that all Elixir practice exercises follow problem specifications, except for when it doesn't make any sense in Elixir.
Important:
- Get familiar with the problem specifications repository and the
canonical-data.jsonformat it uses for describing tests cases. - Read
CONTRIBUTING.mdfor the general rules of this repository. - Read
exercises/practice/<exercise>/.meta/design.mdif it exists to learn about design decision that we took in the past for this exercise (e.g. to drop a required function fromresistor-color). Create this file if you're making unexpected decisions yourself! - Please create separate a PR per exercise when changing tests.
Step 3.3.1 Update tests.toml
Update tests.toml by running this command for a chosen exercise:
$ ./bin/configlet sync --exercise <exercise-slug> --tests include --update
This command assumes that we want to implement all the new tests, and that is our default approach, but it still needs verifying on a test-by-test base.
Step 3.3.2 Analyze the new test cases and update the Elixir tests files accordingly
Find all the test cases affected by the previous step in the exercise's canonical-data.json file in the problem specifications repository. Analyze what the changes actually are.
You might need to delete a test. You might need to add a new test. You might also need to replace an existing test with a new one (you'll see in tests.toml that it "reimplements" another).
If you believe a new test case shouldn't be implemented, add include = false to it in tests.toml and document why in exercises/practice/<exercise>/.meta/design.md.
When editing the Elixir tests, make sure to:
- Follow the coding style used in the existing test file.
- Use the test description from the
tests.tomlfile as texts ofdescribeandtestblocks (unless that would invalidate the first rule). - Keep the order of the tests in the Elixir test file the same as they are in the
tests.tomlfile (unless that would invalidate the first rule). - "Translate" problem specification requirements into Elixir idioms. E.g. when problem specifications say "returns an error", you probably want to use a
{:ok, result} | {:error, error}return type (not raise errors!).
Step 3.3.3 Check that the example solution works with new test cases
After modifying the Elixir tests, run this command:
./bin/test_exercises.sh <exercise-slug>
If it fails, double-check if the new tests are correct. If they are, that means our example solution for this exercise is no longer valid for the new tests and needs to be updated!
When adding a completely new function that students need to implement, or when changing the return types of an existing one, make sure to also update the stub file.
Need help?
- Configlet docs
- General track docs
- Don't hesitate to ask here in case you can't find answers to your questions!
- 主要言語
- Elixir
- スター
- 665
- フォーク
- 415
- 平均マージ
- 13時間 3分
- マージ済み PR(30日)
- 12
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
exercism/elixir のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
-
48in24 Approaches for Raindrops再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
exercism/elixir#1420 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
exercism/elixir#1162 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
exercism/elixir#1133 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
exercism/elixir の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
intellij-elixir/intellij-elixir#4782 ·
メンテナーはふだん 1 日以内に返信
-
level 2 wocs
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
phravins/QuantumBilling#51 ·
-
fix(ocr): compile the Tesseract-free pipeline with Tokio runtime対応中かも @Goldziher が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
carverauto/serviceradar#6898 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
elixir-ecto/myxql#221 ·