Improve the structure of `Settings` in the hackbot-api service
Open
Nobody has claimed this yet.
hackbot
- Dominant language
- Python
- Stars
- 570
- Forks
- 351
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 65
Description
These settings live in services/hackbot-api/app/config.py and could be better organized. Specifically:
- Ensure that settings which should be mandatory are actually marked as mandatory.
- Clean up unnecessary comments, and condense overly long ones.
- Use consistent naming for webhook settings, ideally by nesting them under their respective platform's settings. For example, the Phabricator config should include its webhook config as well.
Contributor guide
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 by reading services/hackbot-api/app/config.py and map the existing settings, comments, and webhook configuration for each platform. Mark settings that are intended to be mandatory, remove or condense unnecessary comments, and consistently nest webhook settings under their platform settings, including Phabricator. Done means the settings structure and naming are consistent and required values are enforced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100