Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

21 lines (12 loc) · 3 KB
Raw

Contributing to Angular-Google-Chart

Thank you for taking the time to contribute to Angular-Google-Chart.

To help you make the most of your effort to contribute to this project, I've assembled a few guidelines for posting issues and pull-requests.

Issues

  • How do I...? A large number of our issues are requests for how-to's. We're always happy to help, and we know the documentation for this project could use some work. When posting a request for a how-to, please give a sample of the HTML and JavaScript that you've got so far. The best way to do this is with a demo on http://plnkr.co/, but some HTML and/or JavaScript in the issue itself works just fine, too.

  • Wouldn't it be nice if...? For feature requests, an explanation of your desired use case would be appreciated. Many people in many projects (Open Source or not) make requests for features that they would never actually use. In order for our volunteer developers to use their time to best effect, please give a full description of why you want a feature and how you plan to use it. The more details the better, but we understand when some details must be kept confidential.

  • Eeew, bugs! When submitting a bug report, please include some of the HTML and JavaScript from your project that can be used to reproduce the bug. We find it even more helpful when bug reports include an example on http://plnkr.co/, because then we can see exactly how it behaves and how it has been found. Please also include and errors produced on the JavaScript Console from your Browser, or a screenshot of the bug's effect if there are no errors.

Pull Requests

  • Working with Branches The master branch is used for releases. Code in master is what people get when they use tools like Bower or npm. Development is done on gh-pages. This is where you should be working from to make changes, and also where you should be sending pull requests to.

  • Editor Configuration Sometimes your IDE or Text Editor tries to fix formatting for you. This can be problematic as making non-functional changes to the file can lead to unnecessary merge conflicts later. To help avoid this our project has a .editorconfig file. See http://EditorConfig.org/ for information on this file and where to get a plug-in for your editor of choice to work with these settings.

  • Backward Compatibility Please keep in mind that there are hundreds (if not thousands) of people using this project already. Changes should not break existing installations unless absolutely necessary. If you have and idea but don't know how to implement it without breaking things, post and issue or pull request and we'll help you work it out.

  • It's just a wrapper. Please keep in mind when adding new features that this project is just a wrapper of the Google Charts API. Some things we simply cannot change because we have no control over them, and others we may be reluctant to change because we'd like to keep things simple.