Skip to content

Commit

Permalink
add issue pr tempaltes and update contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
odoe committed Feb 13, 2018
1 parent e6d4454 commit e9a1fc2
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 5 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,31 @@
<!--- Provide a general summary of the issue in the Title above -->

## Description
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->

## Expected Behavior
<!--- Tell us what should happen -->

## Actual Behavior
<!--- Tell us what happens instead -->

## Possible Fix
<!--- Not obligatory, but suggest a fix or reason for the bug -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Context
<!--- How has this bug affected you? What were you trying to accomplish? -->

## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link to your project if available:
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,36 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] 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.
64 changes: 59 additions & 5 deletions 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)

0 comments on commit e9a1fc2

Please sign in to comment.