Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add exercise notebook dev to contributing

Open
  • Is something wrong?
#396 0 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with CONTRIBUTING.md and compare its exercise-notebook guidance with the README in the exercise-notebook-answers repository. Add a concise note explaining how exercise notebooks are developed, including that notebooks missing from that repository may be deleted. Done means contributors are directed away from editing those files directly.

Written by the indexing model from the issue text.

Description

contributing

We should probably include a note about how exercise notebooks are developed in CONTRIBUTING.md, lest people think that they should edit those files directly.

A lot of this is now covered in the readme for the exercise-notebook-answers repo, but the highlights, including the fact that that repo will delete exercise notebooks that do not exist there.

Dominant language
HTML
Stars
80
Forks
35
Avg merge
21h 53m
Merged PRs (30d)
26

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AlexsLemonade/training-modules

All issues in AlexsLemonade/training-modules

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.