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

šŸ“š derive: the "start a list roll-up one rung up" idiom, since a type cannot `copy` its own `id` into its own field

Open Beginner friendly
#2,379 0 comments 0 reactions 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
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read the derive documentation section for the copy kind and the existing collect chain example. Add a short example showing a list roll-up that starts one rung up, with a sentence explaining why a type cannot copy its own id into its own field. Done when both the example and explanation appear beside the existing chain example.

Written by the indexing model from the issue text.

Description

documentation pkg: sphinx-needs

What happens

The derive kind copy of id into an array field is refused on the type whose own ids are wanted (both tools, same reason), so a list roll-up of requirement ids has to start one rung down: on a demo project chain_reqs is a copy of id over satisfies with select = "list" on the architecture type, then a collect on every rung below. That is the right idiom, and nothing in the derive documentation says so.

What to do

A short "start a list roll-up one rung up" example under the copy kind (and a sentence on why a type cannot copy its own id into its own field), beside the existing collect chain example.

Dominant language
Python
Stars
309
Forks
103
Avg merge
4h 40m
Merged PRs (30d)
154

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 useblocks/sphinx-needs

All issues in useblocks/sphinx-needs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.