Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

56 lines (34 loc) · 1.61 KB

Contributing

First, thanks for wanting to contribute. You’re awesome! ❤️

Questions

Use Stack Overflow with the tag chartkick.

Feature Requests

Create an issue. Start the title with [Idea].

Issues

Think you’ve discovered an issue?

  1. Search existing issues to see if it’s been reported.
  2. Try the master branch to make sure it hasn’t been fixed.

If the above steps don’t help, create an issue. Include:

  • Recreate the problem by forking this gist. Include a link to your gist and the output in the issue.
  • For exceptions, include the complete backtrace.

Pull Requests

Fork the project and create a pull request. A few tips:

  • New features should be added to Chart.js at the very least.
  • Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
  • Follow the existing style. The code should read like it’s written by a single person.

Feel free to open an issue to get feedback on your idea before spending too much time on it.

Also, note that we aren’t currently accepting new chart types.

Dev Setup

To get started with development and testing:

git clone https://github.com/ankane/chartkick.js.git
cd chartkick.js
yarn
yarn build

# start web server
yarn global add serve
serve

And visit http://localhost:5000/examples in your browser.


This contributing guide is released under CCO (public domain). Use it for your own project without attribution.