CONTRIBUTING: Guidelines for numbering and naming notebooks
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- r
- Domain
- documentation
Research direction
Start with the existing CONTRIBUTING guidance and review the discussion in #236 for the agreed naming rules. Check how make-live.R handles the -live.R conversion, then document the 00-, numbered, and exercise_ naming conventions, including the ordering examples, in the relevant contribution guidance.
Written by the indexing model from the issue text.
Description
Synthesizing what we already have + the discussion from #236:
- Reference documents (those we do not intend to cover during training) should be prefixed with
00-. If there are multiple references for a document,00should be followed by a lowercase letter that reflects their order, e.g.,00a-,00b-. - Notebooks that are covered with participants are sequentially ordered, e.g.,
01-,02-.- These become
-live.Rmdwhen we runmake-live.R.
- These become
- Exercise notebooks should be prefixed with
exercise_<NUMBER>-and numbered sequentially. If there are multiple notebooks for a given topic, use lowercase letters after the number. For example, from the
- Dominant language
- HTML
- Stars
- 80
- Forks
- 35
- Avg merge
- 20h 28m
- Merged PRs (30d)
- 29
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AlexsLemonade/training-modules
-
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
AlexsLemonade/training-modules#1112 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
AlexsLemonade/training-modules#1016 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
AlexsLemonade/training-modules#1015 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
AlexsLemonade/training-modules#997 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
AlexsLemonade/training-modules#970 ·
Maintainers usually reply within 1 day
All issues in AlexsLemonade/training-modules
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
aws-samples/sample-per-model-bedrock#295 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
zephyrproject-rtos/reqmgmt#177 ·
-
documentation Size: XS
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
docs(simulation): Quickstart publishes UDP 14550, which the SITL images' own docs say not to doOpenstatus:needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
PX4/PX4-Autopilot#29292 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 83/100