From b52309bf318c9f84fd17194207c92906dff808b2 Mon Sep 17 00:00:00 2001
From: BethanyG
Date: Fri, 15 Oct 2021 04:51:35 -0700
Subject: [PATCH] Added checklists and more typo correction..
---
CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++----
1 file changed, 36 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9a70b7a1..2ab4a2b8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -95,7 +95,6 @@ When in doubt, 📛 [ Open an issue ][open-an-issue]📛 . We wil
-
Prose Writing Style and Standards
@@ -243,11 +242,45 @@ The track `test runner`, `analyzer`, and `representer` run in docker on `python:
- ✅ Concept Exercise Checklist
+
+ ✅ Concept Exercise Checklist
+
+
+
+ - [ ] `.docs/hints.md`
+ - [ ] `.docs/instructions.md`
+ - [ ] `.docs/introduction.md`
+ - [ ] `.meta/config.json`
+ - [ ] `.meta/design.md`
+ - [ ] `.meta/exemplar.py` (_exemplar solution_)
+ - [ ] `_test.py` (_test file_)
+ - [ ] `.py` (_stub file_)
+ - [ ] `concepts/../introduction.md`
+ - [ ] `concepts/../about.md`
+ - [ ] `concepts/../links.json`
+ - [ ] `concepts/../.meta/config.json`
+
- ✅ Practice Exercise Checklist
+
+ ✅ Practice Exercise Checklist
+
+
+
+ - [ ] `.docs/instructions.md`(**required**)
+ - [ ] `.docs/introduction.md`(_optional_)
+ - [ ] `.docs/introduction.append.md`(_optional_)
+ - [ ] `.docs/instructions.append.md` (_optional_)
+ - [ ] `.docs/hints.md`(_optional_)
+ - [ ] `.meta/config.json` (**required**)
+ - [ ] `.meta/example.py` (**required**)
+ - [ ] `.meta/design.md` (_optional_)
+ - [ ] `.meta/template.j2` (_template for generating tests from canonical data_)
+ - [ ] `.meta/tests.toml` (_tests configuration from canonical data_)
+ - [ ] `_test.py` (_**auto-generated from canonical data**_)
+ - [ ] `.py` (**required**)
+
@@ -356,7 +389,6 @@ configlet generate --spec-path path/to/problem/specifications
[concept-exercise-anatomy]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md
[concept-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md
[config-json]: https://github.com/exercism/javascript/blob/main/config.json
-[configlet-general]: https://github.com/exercism/configlet
[configlet]: https://github.com/exercism/docs/blob/main/building/configlet/generating-documents.md
[configlet-lint]: https://github.com/exercism/configlet#configlet-lint
[distinguishing-test-iterations]: https://docs.python.org/3/library/unittest.html#distinguishing-test-iterations-using-subtests