Make explain plugin configurable
Open
Nobody has claimed this yet.
area/config
documentation
enhancement
- Dominant language
- Python
- Stars
- 67
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
Description
`explain` currently uses hardcoded coala explanations. Configuring sub-directories `explain/generic` and `explain/` so that other organizations can include their culture-specific explanations.
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 locating the explain plugin and reading how its hardcoded coala explanations are selected. Work out how the explain/generic and explain/ sub-directories should be configured for organization-specific content, then verify that the plugin can use those configured explanations without relying on the current hardcoded set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100