Skip to content

contributing.md

Latest commit

 

History

History
42 lines (29 loc) · 1.12 KB

contributing.md

File metadata and controls

42 lines (29 loc) · 1.12 KB

Contributing to React Native Chart Kit

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Suggestions and pull requests are highly encouraged! Have a look at the open issues.

Branch names

Use lowercase kebab-case branch names in this format:

<type>/<short-summary>

Use these branch types:

  • fix/ for user-visible bug fixes
  • feat/ for new public functionality
  • docs/ for documentation-only changes
  • ci/ for automation and CI changes
  • chore/ for maintenance, release hygiene, and dependency upkeep
  • refactor/ for internal changes that do not intentionally change behavior
  • release/ for version bump and publishing prep

Include an issue number when the branch maps to a specific issue, for example fix/733-svg-gradient-ids. Keep each branch scoped to one pull request.

Workflow

First clone:

git clone git@github.com:indiespirit/react-native-chart-kit.git
cd react-native-chart-kit
npm install --legacy-peer-deps

Verify the package before opening a pull request:

npm run typecheck
npm run build