Add a contributor setup guide

Open Beginner friendly
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python, redis
Domain
developer-experience, documentation

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.

Description

good first issue

Goal

Create a short contributor-oriented setup section covering the prerequisites that are easy to miss.

Acceptance criteria

  • Explain Python 3.13 and uv setup.
  • Explain that Redis must run on localhost:6379.
  • Mention the Whisper model and FFmpeg requirements for audio work.
  • Include the test and lint commands.
Dominant language
Python
Stars
3
Forks
10
Avg merge
14h 44m
Merged PRs (30d)
9

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ashrafee-dev/scamshield-api

All issues in ashrafee-dev/scamshield-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.