Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

Latest commit

 

History

History
84 lines (54 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

84 lines (54 loc) · 4.11 KB
Raw

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

How you can contribute code to this repository

Make a new branch in the repo

Start contributing to the solutions-geoprocessing-toolbox repo by making a branch. Make a new branch from dev on github.com:

Select the dev drop down Type a new branch name. The convention uses your initials and a title separated by dashes "-". For example: xy-new-suitabilty-tool

Create new branch

Fetch and merge the new branch from the Esri remote: Getting Changes from the repo.

Then checkout your new branch:

git checkout <new_branch>

Getting Changes from the repo

The solutions-geoprocessing-toolbox repo changes without notice, so make sure you are getting the latest updates often.

Using git command line check your remote:

> git remote -v

This command should return a list of remotes including:

Esri https://github.com/Esri/solutions-geoprocessing-toolbox.git (fetch) Esri https://github.com/Esri/solutions-geoprocessing-toolbox.git (push)

Then fetch the changes from the Esri remote:

> git fetch Esri

And merge the changes into the target branch:

> git merge Esri/<target branch>

This will get your new branch from the repo.

Make some code

The following guides are strongly suggested and encouraged:

And of course PEP20 - The Zen of Python

Also make sure that new toolboxes follow the organizational structure of geoprocessing tools. Most of the toolboxes (whether .TBX or .PYT) usually contain other stuff that they use to work. This could be a .LYR for rendering output, or a geodatabase look-up table as an input. To make sure that the tool can easily and consistently find the associated data and files we use a specific folder organization. It looks like this:

  • [toolboxes] - highest level folder
    • mytools_arcmap.tbx - example toolbox
    • othertools_pro.pyt - example toolbox
    • [scripts] - folder containing .PY or other script files needed by the toolbox
      • somescript1.py - example script file
      • somescript2.py - example script file
      • otherscript.py - example script file
    • [layers] - all of those .LYR or .LYRX files used in drawing tool results go here
      • somescript1output.lyr - example layer file
      • otherscriptoutput.lyr - example layer file
    • [tooldata] - this folder contains any data used by the tools. This could be file geodatabases, Microsoft Excel spreadsheets, TXT files, Shapefiles, .JSON bits, etc., but no test/sample data. See notes below.
      • [mytools.gdb] - example file geodatabase

A few things to keep in mind:

  • The folder names, eg. "toolboxes", "scripts", "layers", "tooldata", are specific and are intentionally kept lowercase with no spaces or underscores.
  • The "tooldata" folder MUST NOT contain test data or sample data. It is ONLY for data that the tool requires to operate. Sample data and test data go somewhere else.

Share Your Mods

If you've made changes to the repo that you want to share with the community.

  • Commit your changes
  • Sync local with your remote
  • Make a Pull Request from your remote fork on github.com New Pull Request

Notes On Contributing

  • Always work in the dev branch, never in master. This helps us keep our releases clean.
  • Never merge Pull Requests. The Repository Owner needs to test any updates to make sure the repo is stable.
  • Always log an Issue for problems you find, though you should check through the existing issues to make sure it wasn't already logged.