Add Installation Guidelines in README.md
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 836
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 1
Description
Describe the bug
I found it inconvenient to go to documentation every time I wanted to install bandit. Most of the open source projects do have their installation info mentioned in their README.md.
Reproduction steps
None.
Expected behavior
Well documented installation guidelines in the README.md.
Bandit version
1.8.3 (Default)
Python version
3.13 (Default)
Additional context
Additional context
Similar open soource projects do have their installation guidelines in their README.md
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 README.md and the existing installation documentation to identify the installation steps that should be brought into the README. Done means the README contains clear, accurate installation guidelines for Bandit without requiring readers to visit separate documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100