Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 1.52 KB

Contributing to browser-use-node

Thank you for your interest in contributing to browser-use-node! This document provides guidelines and instructions for contributing.

Development Process

  1. Ensure your code follows the TypeScript best practices
  2. Update documentation as needed
  3. Add tests for new features
  4. Make sure all tests pass: bun test
  5. Create a Pull Request with a clear description of changes

Code Style

  • Use TypeScript for all new code
  • Follow existing code formatting (use provided ESLint and Prettier configurations)
  • Write meaningful commit messages
  • Add JSDoc comments for public APIs

Testing

  • Write unit tests for new features
  • Ensure existing tests pass
  • Include real-world scenario tests when applicable

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: 
    bun install
  3. Create a branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Make your changes
  5. Run tests: 
    bun test
  6. Submit a pull request

Pull Request Process

  1. Update documentation for any new features
  2. Add tests for new functionality
  3. Update the README.md if needed
  4. Ensure all tests pass
  5. Request review from maintainers

Questions?

If you have questions or need help, please:

  1. Check existing issues
  2. Create a new issue with a clear description
  3. Tag it appropriately (question/bug/feature)

License

By contributing, you agree that your contributions will be licensed under the same license as the project.