client-freqwatch/Chart.js/CONTRIBUTING.md

   1 Contributing to Chart.js
   2 ========================
   3
   4 Contributions to Chart.js are welcome and encouraged, but please have a look through the guidelines in this document before raising an issue, or writing code for the project.
   5
   6
   7 Using issues
   8 ------------
   9
  10 The [issue tracker](https://github.com/nnnick/Chart.js/issues) is the preferred channel for reporting bugs, requesting new features and submitting pull requests.
  11
  12 If you're suggesting a new chart type, please take a look at [writing new chart types](https://github.com/nnnick/Chart.js/blob/master/docs/06-Advanced.md#writing-new-chart-types) in the documentation, and some of the [community extensions](https://github.com/nnnick/Chart.js/blob/master/docs/06-Advanced.md#community-extensions) that have been created already.
  13
  14 To keep the library lightweight for everyone, it's unlikely we'll add many more chart types to the core of Chart.js, but issues are a good medium to design and spec out how new chart types could work and look.
  15
  16 Please do not use issues for support requests. For help using Chart.js, please take a look at the [`chartjs`](http://stackoverflow.com/questions/tagged/chartjs) tag on Stack Overflow.
  17
  18
  19 Reporting bugs
  20 --------------
  21
  22 Well structured, detailed bug reports are hugely valuable for the project.
  23
  24 Guidlines for reporting bugs:
  25
  26  - Check the issue search to see if it has already been reported
  27  - Isolate the problem to a simple test case
  28  - Provide a demonstration of the problem on [JS Bin](http://jsbin.com) or similar
  29
  30 Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.
  31
  32
  33 Pull requests
  34 -------------
  35
  36 Clear, concise pull requests are excellent at continuing the project's community driven growth. But please review [these guidelines](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) and the guidelines below before starting work on the project.
  37
  38 Guidlines:
  39
  40  - Please create an issue first:
  41    - For bugs, we can discuss the fixing approach
  42    - For enhancements, we can discuss if it is within the project scope and avoid duplicate effort
  43  - Please make changes to the files in [`/src`](https://github.com/nnnick/Chart.js/tree/master/src), not `Chart.js` or `Chart.min.js` in the repo root directory, this avoids merge conflicts
  44  - Tabs for indentation, not spaces please
  45  - If adding new functionality, please also update the relevant `.md` file in [`/docs`](https://github.com/nnnick/Chart.js/tree/master/docs)
  46  - Please make your commits in logical sections with clear commit messages
  47
  48 Joining the Project
  49 -------------
  50  - Active committers and contributors are invited to introduce yourself and request commit access to this project.  Please send an email to hello@nickdownie.com or file an issue.
  51
  52 License
  53 -------
  54
  55 By contributing your code, you agree to license your contribution under the [MIT license](https://github.com/nnnick/Chart.js/blob/master/LICENSE.md).