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

🧪 derive corpus: the cases phase 2 measured but never wrote (parts of imported needs, include_parts inline, nested-need fingerprint, computed tags default, global_options link default, defaults in by-type-invalid-shapes)

Open
  • Is something wrong?
#2,215 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
testing

Research direction

Start with derive_conformance.toml, the shared conformance corpus, and the existing cases for needimport, needs_external_needs, include_parts, needs_fields and needs_global_options. Each listed case needs a few lines of TOML whose expectations come from a build of this repository, including the by-type-invalid-shapes case, which needs a default on the invalid-entry fields. Done means each case is written, its expected values match a real build, and the phase-2 measurements it records are reproduced.

Written by the indexing model from the issue text.

Description

pkg: sphinx-needs testing
What

Cases the phase-2 program measured on both tools but never wrote into derive_conformance.toml (useblocks/ubcode vendors the file byte for byte, so each case lands in both tools' suites for free):

  • parts of imported (needimport) and external (needs_external_needs) needs as include_parts candidates of a links rule;
  • include_parts=True in the inline spellings of filter-inline-spellings (links_from_filter, copy(filter=…));
  • a parent with a nested need, for fingerprint / content (measured equal in both tools; not pinned);
  • a computed tags default ([[…]] in needs_fields tags — portable in both tools now);
  • a link type's computed default through needs_global_options (portable now, useblocks/ubcode#4052);
  • by-type-invalid-shapes (useblocks/sphinx-needs#2205): give the invalid-entry fields (entry_not_table, entry_invalid) a default, so "the type's needs hold the placeholder" (null) and "the type falls back to the default" are different values and the case can tell them apart (today both are null; found by the review of useblocks/ubcode#4061).
Why here

The corpus is recorded on the sphinx-needs side first; ubCode re-vendors (the window row of derived-need-values.md §8). Each case is a few lines of TOML; the expectations come from a build of this repository.

Dominant language
Python
Stars
309
Forks
103
Avg merge
10h 41m
Merged PRs (30d)
128

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.