Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 1.55 KB

Contributing to react-use-intercom

Preparing

  1. Install pnpm:
npm install -g [email protected]
  1. Fork and clone the repository
  2. Install dependencies:
pnpm install
  1. The project uses a monorepo structure with pnpm workspaces:
  • /packages/react-use-intercom: Main library package
  • /apps/playground: Development playground
  • /apps/examples: Example applications

Development Workflow

  1. Create a new branch for your feature/fix:
git checkout -b your-feature-name

  1. Make your changes in the appropriate package

  2. To test your changes:

    • Start the playground: pnpm dev
    • Run the test suite: pnpm test
    • Run E2E tests: pnpm test:e2e

  3. Create a changeset to document your changes:

pnpm changeset

Follow the prompts to describe your changes. This step is required for any user-facing changes.

  1. Before submitting your PR:
    • Ensure all tests pass
    • Add or update tests as needed
    • Follow the existing code style
    • Update documentation if necessary
    • Verify your changeset accurately describes the changes

Pull Request

  1. Update the README.md with details of changes if applicable
  2. Ensure your PR includes a changeset if it includes user-facing changes

Testing

  • Write unit tests for new features
  • Update existing tests when modifying features
  • Ensure all tests pass before submitting a PR
  • Add E2E tests for new user-facing features

Documentation

  • Update the README.md if you add or modify features
  • Include JSDoc comments for public APIs
  • Keep documentation clear and concise