Skip to content

Contributing

We welcome contributions! Bug fixes and Angular compatibility improvements are especially appreciated.

Reporting issues

Search existing issues first. If your issue is new, please include:

  • Angular and ng-charts versions
  • Steps to reproduce
  • Screenshots (charts are visual -- screenshots help a lot)
  • Browser and OS

Development setup

git clone https://gitlab.com/glitchtip/ng-charts.git
cd ng-charts
npm install

Available commands

Command Description
npm start Run the demo app
npm run build:lib Build the library
npm run build:lib:prod Production build (partial compilation)
npm run test:unit Run unit tests
npm run lint Lint the code

Building

The library is built with ng-packagr. The source lives in projects/swimlane/ngx-charts/src/.

Merge requests

  1. Fork the project on GitLab
  2. Create a feature branch
  3. Make your changes
  4. Run npm run lint and npm run test:unit
  5. Submit a merge request

For major features, open an issue first to discuss the approach.

Credits

This project was originally created by Swimlane as @swimlane/ngx-charts. The Swimlane team and many open source contributors built and maintained this library for the Angular community over many years. We're grateful for their work.

See the original project for the full contributor history.