Skip to content

How to Contribute

Thank you for your interest in contributing to the UiPath TypeScript SDK! We welcome contributions from the community.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a feature branch from main
  4. Make your changes and test them
  5. Submit a pull request

Development Setup

# Clone your fork
git clone https://github.com/your-username/uipath-typescript.git
cd uipath-typescript

# Install dependencies
npm install

# Build the project
npm run build

Contribution Guidelines

Code Style

  • Follow existing code patterns and conventions
  • Use TypeScript for type safety
  • Include JSDoc comments for public APIs
  • Ensure proper error handling

Documentation

  • Update relevant documentation
  • Include code examples
  • Document breaking changes
  • Update TypeScript definitions

Pull Request Process

  1. Ensure your code builds without warnings
  2. Update documentation as needed
  3. Write clear commit messages
  4. Submit your pull request with a detailed description

Reporting Issues

When reporting bugs or requesting features:

  • Use the issue templates provided
  • Include clear steps to reproduce
  • Provide environment details
  • Include relevant code examples

Code of Conduct

We expect all contributors to follow professional standards:

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help maintain a welcoming environment
  • Follow GitHub's community guidelines

Questions?

If you have questions about contributing:

  • Check existing issues and discussions
  • Create a new issue with the "question" label
  • Join our community discussions

We appreciate your contributions to making the UiPath TypeScript SDK better!