From e9a1fc28edd33afc0926eccc669ff10f73cfe752 Mon Sep 17 00:00:00 2001 From: rene rubalcava Date: Tue, 13 Feb 2018 09:38:21 -0800 Subject: [PATCH] add issue pr tempaltes and update contributing doc --- .github/ISSUE_TEMPLATE.md | 31 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 36 ++++++++++++++++++ CONTRIBUTING.md | 64 +++++++++++++++++++++++++++++--- 3 files changed, 126 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..3932007 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,31 @@ + + +## Description + + +## Expected Behavior + + +## Actual Behavior + + +## Possible Fix + + +## Steps to Reproduce + + +1. +2. +3. +4. + +## Context + + +## Your Environment + +* Version used: +* Browser Name and version: +* Operating System and version (desktop or mobile): +* Link to your project if available: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..fab5004 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + +## Related Issue + + + + + +## Motivation and Context + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b647992..2e6d794 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,63 @@ -Esri welcomes contributions from anyone and everyone. Please see our -[guidelines for contributing](https://github.com/esri/contributing). +Contributing to maps-app-javascript +================================= -# Contributing to [ArcGIS API for Javascript](http://js.arcgis.com) +Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing). -There are several ways you can ask for assistance or provide feedback on the [ArcGIS API for Javascript](http://js.arcgis.com) from [Esri](https://www.esri.com/). + 1. [Getting Involved](#getting-involved) + 2. [Reporting Bugs](#reporting-bugs) + 3. [Contributing Code](#contributing-code) + +## Getting Involved + +Third-party patches are absolutely essential on our quest to create the best maps app with the ArcGIS API for JavaScript. +However, they're not the only way to get involved with the development of maps-app-javascript. +You can help the project tremendously by discovering and [reporting bugs](#reporting-bugs), +[improving documentation](#improving-documentation), +helping others with [GitHub issues](https://github.com/Esri/maps-app-javascript/issues), +tweeting to [@ArcGISJSAPI](https://twitter.com/ArcGISJSAPI), +and spreading the word about mapps-app-javascript and the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/) among your colleagues and friends. + +## Reporting Bugs + +Before reporting a bug on the project's [issues page](https://github.com/Esri/maps-app-javascript/issues), +first make sure that your issue is caused by maps-app-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 maps-app-javascript. +If your issue is related to the ArcGIS API for JavaScript, please contact [Esri Tech Support](https://support.esri.com/contact-tech-support) or ask the Esri community on [GeoNet](https://geonet.esri.com/community/developers/web-developers/arcgis-api-for-javascript). + +After you made sure that you've found a new maps-app-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](https://github.com/Esri/maps-app-javascript/blob/master/README.md) to set up your development environment. + +#### Fork the repo +If you haven't already, got to https://github.com/Esri/maps-app-javascript and click the [Fork](https://github.com/Esri/maps-app-javascript/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](https://github.com/felixrieseberg/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://127.0.0.1:8080`. +* `npm run build` - compile application for deployment that can be viewed at `http://127.0.0.1:9000`. +* `npm test` - run unit tests and code coverage with local chrome driver. + +The ports for running the local server can be updated in `webpack/devserver.config.js` for dev and `package.json` for build. + +#### Configure remotes +Move into the directory the cloning process just created (should be maps-app-javascript), then make sure your local git knows about all the remotes and branches. +``` +$ cd maps-app-javascript +# Changes the active directory in the prompt to the newly cloned "maps-app-javascript" directory +$ git remote add upstream https://github.com/Esri/maps-app-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 +``` -* Contact [Esri Tech Support](https://support.esri.com/contact-tech-support) * Ask the Esri community on [GeoNet](https://geonet.esri.com/community/developers/web-developers/arcgis-api-for-javascript)