ashrafee-dev / ashrafee-dev/scamshield-api
Add a contributor setup guide
Open
Beginner friendly
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 3
- Forks
- 10
- Avg merge
- 14h 44m
- Merged PRs (30d)
- 9
Description
Goal
Create a short contributor-oriented setup section covering the prerequisites that are easy to miss.
Acceptance criteria
- Explain Python 3.13 and
uvsetup. - Explain that Redis must run on
localhost:6379. - Mention the Whisper model and FFmpeg requirements for audio work.
- Include the test and lint commands.
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 the existing documentation structure and the project's current test and lint commands. Add a short contributor setup section covering Python 3.13, uv, Redis at localhost:6379, Whisper, FFmpeg, and the commands; it is done when every acceptance criterion is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, redis
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100