A new 'linting' section should be added to the plugin_template
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 40
- Avg merge
- 21h 24m
- Merged PRs (30d)
- 8
Description
Migrated from https://pulp.plan.io/issues/6721
This section should contain the configuration for flake8 and if possible black. That way we can keep those configurations consistent and updated in all repositories that opt in to comply to the same linting rules.
This may also be important for files that are not related to linting. All files that are meant to be updated with plugin-template should not be in the "bootstrap" section. And the on the other hand for example the doc stubs that are meant to be filled by the plugin writer should move to the "boostrap" section while the docs-building machinery should be an updateable section.
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 inspecting the plugin_template configuration, especially the bootstrap section and the files intended for updates. Define a linting section containing the flake8 and, if possible, black configuration, while separating updateable documentation-building machinery from plugin-writer stubs; done means opted-in repositories receive consistent linting settings without overwriting their filled-in content.
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
- 30/100