Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (39 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 1.53 KB
Raw

Contributing to SignalWire

Thank you for your interest in contributing to SignalWire!

Getting Started

  1. Fork the repository you want to contribute to
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests if available
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Code Standards

  • Follow the existing code style in the repository
  • Write tests for new functionality
  • Update documentation as needed
  • Keep commits atomic and well-described

Reporting Issues

  • Use the issue templates provided
  • Include steps to reproduce for bugs
  • Provide environment details (OS, SDK version, etc.)

Pull Request Guidelines

  • Describe your changes - What does this PR do and why?
  • Reference issues - Link any related issues (e.g., Fixes #123)
  • Test your changes - Ensure existing tests pass and add new ones if needed
  • Keep it focused - One fix or feature per PR

Development Setup

Each repository has its own setup instructions in its README. Generally:

# Clone your fork
git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
cd REPO-NAME

# Install dependencies (varies by project)
npm install          # JavaScript/TypeScript
pip install -e .     # Python
bundle install       # Ruby

Questions?