Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 3.86 KB
Raw

Contributing to nearby-places-javascript

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

  1. Getting Involved
  2. Reporting Bugs
  3. Contributing Code

Getting Involved

Third-party patches are absolutely essential on our quest to create the best nearby places app with the ArcGIS API for JavaScript. However, they're not the only way to get involved with the development of nearby-places-javascript. You can help the project tremendously by discovering and reporting bugs, improving documentation, helping others with GitHub issues, tweeting to @ArcGISJSAPI, and spreading the word about mapps-app-javascript and the ArcGIS API for JavaScript among your colleagues and friends.

Reporting Bugs

Before reporting a bug on the project's issues page, first make sure that your issue is caused by nearby-places-javascript, not your application code. Second, search through the reported issues for your issue, and if it's already reported, just add any additional details in the comments.

Also, please only report issues related to the nearby-places-javascript. If your issue is related to the ArcGIS API for JavaScript, please contact Esri Tech Support or ask the Esri community on GeoNet.

After you made sure that you've found a new nearby-places-javascript bug, please use the provided issue template when creating your issue.

Contributing Code

Setting up your dev environment

Please read the instructions provided in the readme to set up your development environment.

Fork the repo

If you haven't already, go to https://github.com/Esri/nearby-places-javascript and click the Fork button.

Clone the repo

Clone the repo and run npm install.

  • NOTE FOR WINDOWS USERS - You will need to install the Windows-Build-Tools to compile npm modules for this project. npm install --global --production windows-build-tools

  • npm start - compile application and run it in a local server at http://localhost:8080/.

  • npm run build - compile application for deployment.

  • npm test - run unit tests with local chrome driver.

  • npm run serve - Run a production build of the application, but serve it up locally to see how the built app will behave.

Use npm run serve to full test that Service Workers are working correctly with webpack-dev-server self signed certifcates. Refer to this article on how to run Chrome with proper flags enabled for development purposes.

Configure remotes

Move into the directory the cloning process just created (should be nearby-places-javascript), then make sure your local git knows about all the remotes and branches.

$ cd nearby-places-javascript
# Changes the active directory in the prompt to the newly cloned "nearby-places-javascript" directory
$ git remote add upstream https://github.com/Esri/nearby-places-javascript.git
# Assigns the original repository to a remote called "upstream"
$ git fetch upstream
# Pulls in changes not present in your local repository, without modifying your files
  • Ask the Esri community in the Example Apps Group on GeoNet.