From 639d004e3920dd62db432dc5bfeba15a471637d1 Mon Sep 17 00:00:00 2001 From: Matt Funk Date: Wed, 24 May 2017 08:52:01 -0700 Subject: [PATCH 1/2] Added style guide info to Contributing Added style guide info to Contributing.MD. including links to PEP8, PEP257, Google Style Guide and Truthful Technology's style guide. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3c62aba..404381d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,16 @@ And *merge* the changes into the target branch: This will get your new branch from the repo. +### Make some code + +The following guides are *strongly* suggested and encouraged: +* [Python PEP8 - Style Guide for Python](https://www.python.org/dev/peps/pep-0008/) +* [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) +* [Truthful Technology's Python Style Guide](https://github.com/TruthfulTechnology/style-guide/blob/master/python.rst) +* [Python PEP257 - docstrings](https://www.python.org/dev/peps/pep-0257/) + +And of course [PEP20 - The Zen of Python](https://www.python.org/dev/peps/pep-0020/) + ### Share Your Mods If you've made changes to the repo that you want to share with the community. From 2faad6f35693c98198541d5addb5f2c91e3c429d Mon Sep 17 00:00:00 2001 From: Matt Funk Date: Tue, 18 Jul 2017 14:23:25 -0700 Subject: [PATCH 2/2] Change 'test data' to discuss arcgis.com --- utils/test/WritingTests.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/utils/test/WritingTests.md b/utils/test/WritingTests.md index 5d048ccd..fcb8b2f3 100644 --- a/utils/test/WritingTests.md +++ b/utils/test/WritingTests.md @@ -37,9 +37,10 @@ They are named **[toolname]TestCase.py** ### Test Data The it is impossible to build a test without some kind of inputs. Some tests generate their own data internally (Check out the ERG tool tests as an example). But most will require some kind of output test data. -* Test data **must** be stored in the *./data* folder. +* Test data **must** be stored on ArcGIS.com (owner:solutions_github). Contact repo owner to upload to this account. * Keep feature data in a file geodatabase. You should name it like your toolbox. * Any file data (CSV, TXT, XLSX, etc.) should be easy to identify which toolbox it belongs to. +* Zip any data before uploading to ArcGIS.com (use type Desktop Application Template). ## Outline for writing tests ### 1. Make a separate branch from dev