Minimize or remove the configuration file `tools.json`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 68
- Forks
- 92
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 16
Description
The config file is growing to be too big, harder to navigate, and introducing merge conflicts. Also, many configs are hard to be understood without a peek into the code, and since it is in a JSON file, it is not a valid syntax to add comments to document the configs.
As discussed on Matrix (@marco-c and @calixteman), moving the configs to the tools themselves could mitigate the problem. The following are some possible directions:
- Add the configs as clear parameters of the init function of the class
- Add a decorator like
@configuration({ "nb_of_days": 3, ... })on top of the class
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 by reviewing tools.json and the configurations it contains, then inspect the tool classes and their init functions mentioned in the issue. Compare the proposed constructor-parameter and @configuration approaches; done means reducing or removing the central file while keeping each configuration understandable and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100