Skip to content

docs: add CONTRIBUTING.md and update documentation references #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2025

Conversation

nullcoder
Copy link
Owner

Summary

  • Created comprehensive CONTRIBUTING.md guide for contributors
  • Updated all documentation references to link to the new contributing guide
  • Marked contribution guidelines task as completed in TODO.md

Changes

New File

  • CONTRIBUTING.md: Complete contribution guide including:
    • Getting started instructions
    • Development workflow with branch naming conventions
    • Code guidelines for TypeScript, React, and security
    • Testing requirements (unit, integration, manual)
    • Pull request process and checklist
    • Code of conduct
    • Communication channels

Updated Files

  • README.md:
    • Updated contributing section to reference CONTRIBUTING.md
    • Added CONTRIBUTING.md to documentation list
  • docs/TODO.md:
    • Marked "Write contribution guidelines" as completed
  • docs/LOCAL_DEVELOPMENT.md:
    • Updated Next Steps section to link to CONTRIBUTING.md
  • CLAUDE.md:
    • Added reference to follow contribution guidelines

Test Plan

  • All markdown files render correctly
  • All internal links work properly
  • Contributing guide covers all essential topics
  • Documentation is consistent across all files

🤖 Generated with Claude Code

- Create comprehensive CONTRIBUTING.md with:
  - Getting started guide
  - Development workflow
  - Code guidelines and standards
  - Testing requirements
  - PR process and checklist
  - Code of conduct
  - Communication channels

- Update references in:
  - README.md: Update contributing section and add to docs list
  - docs/TODO.md: Mark contribution guidelines as completed
  - docs/LOCAL_DEVELOPMENT.md: Update Next Steps section
  - CLAUDE.md: Add reference to follow contribution guidelines

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@nullcoder nullcoder merged commit 044a61c into main Jun 6, 2025
1 check was pending
@nullcoder nullcoder deleted the docs/add-contributing-guide branch June 6, 2025 08:17
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.

1 participant