|
| 1 | +Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing). |
| 2 | + |
| 3 | +### Before filing an issue |
| 4 | + |
| 5 | +Please take a look at [previous issues](https://github.com/Esri/arcgis-python-api/issues?q=is%3Aissue+is%3Aclosed) that resolve common problems. |
| 6 | + |
| 7 | +If you're just looking for help, you'll probably attract the most eyes if you post in the [GeoNet Forums](https://community.esri.com/groups/arcgis-python-api/) or the [GIS Stackexchange](https://gis.stackexchange.com/questions/tagged/arcgis-python-api). |
| 8 | + |
| 9 | +If you think you're encountering a new bug, please feel free to log an [issue](https://github.com/Esri/arcgis-python-api/issues/new) and include the steps to reproduce the problem. |
| 10 | + |
| 11 | +**Please include the following in your issue:** |
| 12 | +* Your conda or pip environment (run `conda list` or `pip freeze` and copy/paste the output into the issue) |
| 13 | +* Any code (or notebook) you executed that made you run into this issue |
| 14 | + |
| 15 | +# Updating errors in existing notebooks |
| 16 | + |
| 17 | +Do you see an error in an existing notebook? Is there a typo, a misnamed variable, and do you know how to fix it? |
| 18 | +* Make the fix in the notebook |
| 19 | +* If you made code changes, re-run the appropriate cells in the notebook |
| 20 | +* Make a copy of the `dev_site_current` branch on your local fork |
| 21 | +* Add the updated notebook to your branch on your fork |
| 22 | +* [Open a pull request](https://help.github.com/articles/about-pull-requests/) from your fork's branch to this repository's `dev_site_current` branch |
| 23 | + |
| 24 | +# Adding new sample notebooks |
| 25 | + |
| 26 | +Do you have a notebook that shows off functionality of the API? Do you want to see that notebook released with the next version of the ArcGIS API for Python? |
| 27 | +* Create a new notebook, make sure it runs consistently on its own on a few systems |
| 28 | + * Make sure the notebook filename is in an `all_lowercase_underscore_delimiter_convention.ipynb` |
| 29 | +* Make a copy of the `dev_site_next_release` branch on your local fork |
| 30 | +* Place the notebook in the correct folder in the `samples/` folder on your fork |
| 31 | +* Add the notebook to your branch on your fork |
| 32 | +* [Open a pull request](https://help.github.com/articles/about-pull-requests/) from your fork's branch to this repository's `dev_site_current` branch |
0 commit comments