How to Contribute to the Taro Open‑Source Project: A Step‑by‑Step Guide

Background

Contributing to open‑source projects helps developers understand large codebases, improve skills, and increase influence. This guide demonstrates the contribution workflow using the Taro frontend framework (≈30 k GitHub stars) as an example.

Selecting a Project

Choose a project that matches the technology stack you already use. For cross‑platform mini‑programs, Taro is a suitable target because its source code is publicly available and actively maintained.

Quick Start

Read the project's contribution guidelines (e.g., the Taro CONTRIBUTING document) before starting.

1. Determine Contribution Type

This guide focuses on submitting code changes.

2. Find an Issue

Search the Taro issue tracker for the label Help Wanted and filter by difficulty. Begin with an Easy issue.

3. Fork and Clone

Fork the repository to your GitHub account and clone it locally:

git clone https://github.com/jiaozitang/taro

4. Set Up Local Development Environment

Install dependencies and build the project:

# Install dependencies
yarn

# Build
yarn build

Identify the packages affected by the issue, link them with yarn link, and run a local development server:

# yarn link
cd packages/taro-components
yarn link

# Local development
yarn dev

Create a test application to verify the changes:

# Install CLI globally
npm install -g @tarojs/cli

# Initialize a new project
taro init myApp

# Link the modified component package
yarn link "@tarojs/components"

5. Development Process

5.1 Feature Implementation

The example resolves issue “textarea component onLineChange event not firing” by:

Adding an onLineChange event that emits when the line count changes.

Calculating the line count from the textarea’s line height during input.

Introducing an auto-height property and corresponding CSS to enable automatic height adjustment.

Source file:

packages/taro-components/src/components/textarea/textarea.tsx

. The pull‑request diff is available at: https://github.com/NervJS/taro/pull/10681/files

5.2 Update Test Cases

Add tests for the new event and property in packages/taro-components/__tests__/textarea.spec.js.

5.3 Update Documentation

Modify the component README ( packages/taro-components/src/components/textarea/index.md) to describe onLineChange and auto-height.

5.4 Self‑Testing

Run the modified Taro app ( myApp) to verify functionality, then execute the full test suite:

# Run automated tests
npm run test

6. Submit a Pull Request

After all tests pass, create a pull request on GitHub.

7. Code Review Process

Address reviewer comments, make required changes, and iterate until the contribution is merged.

References

Taro repository: https://github.com/NervJS/taro

Taro contribution guide: https://taro-docs.jd.com/taro/docs/CONTRIBUTING

Taro codebase overview: https://taro-docs.jd.com/taro/docs/codebase-overview

Issue “textarea component onLineChange event not firing”: https://github.com/NervJS/taro/issues/8003