default config file name
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 836
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
The doc say i should create a YAML config file, but not how to name it. https://bandit.readthedocs.io/en/latest/config.html
Describe the solution you'd like
Please recommend a sane default name, so it is consistent in any project and can be found by CI etc.
I recommend using .bandit.yml because it is hidden on Linux, UNIX and macOS and has an extension.
Describe alternatives you've considered
I don't see any alternatives. Leaving it as is leads to chaos!
Additional context
Codacy says: "You can also use custom .bandit or bandit.yml config file."
I have also seen bandit.yaml in earlier issues.
For a sane solution, i look what similar tools do.
Most .name for INI-style config or .name.yml for YAML config.
pylintrc or .pylintrc: https://pylint.readthedocs.io/en/latest/user_guide/run.html#command-line-options
.flake8
.pycodestyle or config in setup.cfg or tox.ini: http://pycodestyle.pycqa.org/en/latest/intro.html#configuration
.pydocstyle, .pydocstyle.ini, .pydocstylerc, .pydocstylerc.ini: http://www.pydocstyle.org/en/2.1.1/usage.html#configuration-files
.coveragerc
.travis.yml, .circleci, .github, .appveyor.yml
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 with the configuration documentation at bandit.readthedocs.io/en/latest/config.html and inspect how Bandit currently discovers configuration files. Compare the documented behavior with the naming options listed in the issue; done means one default filename is agreed on and the documentation and CI guidance consistently recommend it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools, security
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100