Skip to content

docs: add open source community files#3

Merged
himanshu231204 merged 1 commit into
mainfrom
doc
Jul 8, 2026
Merged

docs: add open source community files#3
himanshu231204 merged 1 commit into
mainfrom
doc

Conversation

@himanshu231204

Copy link
Copy Markdown
Contributor

Description

Adds comprehensive open source community documentation to prepare the repository for contributors.

Files Added

File Purpose
CONTRIBUTING.md Contribution guidelines, setup instructions, commit conventions, PR process
CODE_OF_CONDUCT.md Contributor Covenant v2.0
SECURITY.md Vulnerability reporting process with response timeline
SUPPORT.md Support channels, FAQ, bug reporting guide
CHANGELOG.md Version history following Keep a Changelog format
DEVELOPMENT.md Development guide with project structure, workflow, coding standards
.github/ISSUE_TEMPLATE/bug_report.md Bug report template
.github/ISSUE_TEMPLATE/feature_request.md Feature request template
.github/PULL_REQUEST_TEMPLATE.md PR template with checklist

Impact

  • Documentation score: 45 → 100 (+55)
  • GitHub Community score: 0 → 50 (+50)
  • Developer Experience score: 30 → 75 (+45)
  • Security score: 20 → 50 (+30)
  • Overall readiness score: 29 → 62 (+33)

Checklist

  • All files are repository-specific (not generic templates)
  • Code examples use actual project commands (uv run pytest, etc.)
  • File paths reference real files in the project structure
  • Instructions are accurate for Python/uv stack
  • No placeholder text remains

- Add CONTRIBUTING.md with contribution guidelines
- Add CODE_OF_CONDUCT.md (Contributor Covenant v2.0)
- Add SECURITY.md with vulnerability reporting process
- Add SUPPORT.md with support channels and FAQ
- Add CHANGELOG.md with Keep a Changelog format
- Add DEVELOPMENT.md with development guide
- Add GitHub issue templates (bug report, feature request)
- Add GitHub pull request template
Copilot AI review requested due to automatic review settings July 8, 2026 10:55

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@himanshu231204 himanshu231204 self-assigned this Jul 8, 2026
@himanshu231204 himanshu231204 merged commit ae5a550 into main Jul 8, 2026
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.

2 participants