Clarify BzCleaner bughandler behavior
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 68
- Forks
- 92
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 16
Description
BzCleaner.bughandler only returns a subset of fields and is not linked to the include_fields query parameter.
It's returning the id https://github.com/mozilla/relman-auto-nag/blob/master/auto_nag/bzcleaner.py#L241 and summary by default. It can also returns other few fields based on other methods, assignee https://github.com/mozilla/relman-auto-nag/blob/master/auto_nag/bzcleaner.py#L256, needinfos https://github.com/mozilla/relman-auto-nag/blob/master/auto_nag/bzcleaner.py#L262, etc...
This behavior is a bit confusing and hard to debug. We should declare once which fields do we want.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start in auto_nag/bzcleaner.py at the bughandler code around lines 241, 256, and 262, then trace how the include_fields query parameter is handled. Identify every field bughandler can return and determine how the default and requested field sets relate. Done means the returned fields are declared consistently in one place and the behavior is easier to understand and debug.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100