🐛 github-commits ignores the needservice :id_prefix: option
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Read services/github.py around the github-commits handling near line 378, then compare it with the github-issues and github-prs handling around line 334. Find the existing tests for the GitHub needservice directive and add a case using :id_prefix: CC_; done means the created commit need uses that prefix and its recorded id_prefix remains consistent.
Written by the indexing model from the issue text.
Description
What happens
For github-issues and github-prs, the needservice option :id_prefix: sets the id prefix of the created needs (services/github.py, around line 334 at master 9feaba74). For github-commits it does not: commits always use the service's configured prefix (self.id_prefix, around line 378). Yet the need still records the option's value.
Measured at master 9feaba74: .. needservice:: github-commits with :id_prefix: CC_ created the id GITHUB_abcdef, while the need's id_prefix field held CC_.
What to do
Use the directive's id_prefix for commits as for issues and pull requests, and add a test.
- 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
- 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 useblocks/sphinx-needs
-
documentation pkg: sphinx-needs
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
useblocks/sphinx-needs#2379 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2338 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2335 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2332 ·
Maintainers usually reply within 1 day
-
📚 the "own service" example in docs/services/index.rst cannot be registeredPossibly taken @chrisjsewell claimed this 10 days ago. Opendocumentation pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
useblocks/sphinx-needs#2327 ·
Maintainers usually reply within 1 day
All issues in useblocks/sphinx-needs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Graphify-Labs/graphify#4860 · 1 comment ·
Maintainers usually reply within 1 day
-
:bug: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
scikit-image/scikit-image#8377 ·
Maintainers usually reply within 1 day
-
Ingredient import validation accepts negative nutrient values and NaNPossibly taken @LukeSekai claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
wger-project/wger#2564 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/ponymail-foal#351 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Maintainers usually reply within 4 days