Skip to content

docs: add first contribution development guide - #13

Merged
SinghCod3r merged 1 commit into
SinghCod3r:mainfrom
johndavidagaba:patch-1
Sep 6, 2026
Merged

docs: add first contribution development guide#13
SinghCod3r merged 1 commit into
SinghCod3r:mainfrom
johndavidagaba:patch-1

Conversation

@johndavidagaba

Copy link
Copy Markdown
Contributor

Description

Adds a contributor-focused local development guide to CONTRIBUTING.md for issue #12.

The guide covers cloning the repository, setting up a virtual environment, installing development dependencies, running tests, linting and type checking, understanding the source tree, creating a branch, and opening a pull request.

It also explains how contributors can work on the project without requiring a paid LLM API.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactoring
  • Security fix

Checklist

  • Tests added/updated and passing
  • Linting and formatting passing
  • Documentation updated
  • Security boundaries maintained (no untrusted data execution, secrets redacted)

Closes #12

@SinghCod3r
SinghCod3r merged commit da1ec07 into SinghCod3r:main Sep 6, 2026
3 checks passed
@SinghCod3r

Copy link
Copy Markdown
Owner

@johndavidagaba , Thankyou for Your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a contributor-focused local development guide

2 participants