Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 1.85 KB
Raw

Contributing to Command Code Paperclip Adapter

Thank you for your interest in contributing! This document provides guidelines for contributing to the project.

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what is best for the community
  • Show empathy towards other contributors

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/command-code-paperclip-adapter.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Install dependencies: npm install or pip install -r requirements.txt

Development Workflow

Making Changes

  1. Write clear, descriptive commit messages
  2. Follow the existing code style and conventions
  3. Add tests for new functionality
  4. Update documentation as needed

Testing

# Run tests
npm test  # or pytest

# Run linting
npm run lint  # or flake8

# Run type checking
npm run type-check  # or mypy .

Commit Message Format

Use conventional commits:

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation changes
  • refactor: - Code refactoring
  • test: - Adding or updating tests
  • chore: - Maintenance tasks

Example: feat: add retry logic for failed commands

Pull Request Process

  1. Ensure all tests pass
  2. Update documentation if needed
  3. Add PR description using the template
  4. Request review from maintainers
  5. Address feedback in review

Coding Standards

  • Follow language-specific style guides
  • Keep functions focused and small
  • Add comments for complex logic
  • Use meaningful variable names
  • Write self-documenting code

Reporting Issues

Use the issue templates:

  • Bug reports: .github/ISSUE_TEMPLATE/bug_report.md
  • Feature requests: .github/ISSUE_TEMPLATE/feature_request.md

Questions?

Open a discussion or contact maintainers.

Thank you for contributing!