Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (19 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

36 lines (19 loc) · 1.67 KB
Raw

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Before filing an issue

Please take a look at previous issues that resolve common problems.

More examples

The Esri Cedar website is written using http://assemble.io/ and can be found at https://github.com/Esri/cedar/tree/master/site/source. You can use the existing examples as a reference.

Support for new chart types types

Support for new chart types is always needed.

Setting up a dev environment

Make Sure you have the Grunt CLI installed.

  1. Fork and clone Esri Cedar
  2. cd into the cedar folder
  3. Install the dependencies with npm install
  4. Run grunt docs from the command line. This will start the web server locally at http://localhost:8001 and start watching the source files and running linting and testing commands.
  5. Push your changes using grunt docs:deploy which pushes to your origin/gh-pages
  6. Create a pull request to esri/cedar/gh-pages

Linting

Please make sure your changes pass JS Hint. This will help make sure code is consistant through out Esri Cedar. You can run JS Hint with grunt jshint.

Testing

Please make sure your changes dont break existing tests. Testing is essential for determining backward compatibility and catching breaking changes. You can run tests with grunt karma:run, grunt karma:watch or grunt karma:coverage.