Skip to main content

Contributing

A guide for contributing to the Bitcoin MCP Server project.

Getting Started​

  1. Fork the Repository
git clone https://github.com/AbdelStark/bitcoin-mcp
cd bitcoin-mcp
  1. Install Dependencies
npm install
  1. Run Tests
npm test

Development Guidelines​

Code Style​

  • Use TypeScript
  • Follow existing patterns
  • Add type definitions
  • Keep functions focused

Testing​

  • Write unit tests
  • Maintain coverage
  • Test edge cases
  • Document test scenarios

Documentation​

  • Update relevant docs
  • Add JSDoc comments
  • Keep README current
  • Document breaking changes

Pull Request Process​

  1. Create feature branch
  2. Make changes
  3. Run tests
  4. Update documentation
  5. Submit PR

Code Review Guidelines​

What We Look For​

  • Code quality
  • Test coverage
  • Documentation
  • Performance impact
  • Security considerations

Review Process​

  1. Automated checks
  2. Code review
  3. Documentation review
  4. Final approval