Update contributing docs

- Move the contributing docs to the `docs/` directory
- Convert the Code of Conduct to reStructuredText
- Convert Contributing to reStructuredText and update the document
- Add the contributing docs to the on-line documentation

Author: cmlccie

CONTRIBUTING.md

@@ -1,10 +1,16 @@
-# Contributor Covenant Code of Conduct
+.. _CodeOfConduct:
 
-## Our Pledge
+====================================
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+==========
 
 In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+=============
 
 Examples of behavior that contributes to creating a positive environment include:
 
@@ -22,25 +28,29 @@ Examples of unacceptable behavior by participants include:
 * Publishing others' private information, such as a physical or electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
-## Our Responsibilities
+Our Responsibilities
+====================
 
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
-## Scope
+Scope
+=====
 
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+===========
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
-## Attribution
+Attribution
+===========
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the `Contributor Covenant`_, `version 1.4`_.
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+.. _Contributor Covenant: http://contributor-covenant.org
+.. _version 1.4: http://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.md renamed to docs/code_of_conduct.rst

@@ -0,0 +1,115 @@
+.. _Contributing:
+
+============
+Contributing
+============
+
+*webexteamssdk* is a community development project.  Feedback, thoughts, ideas, and code contributions are most welcome!
+
+
+How to contribute Feedback, Issues, Thoughts and Ideas
+=======================================================
+
+Please use the `issues`_ page to report issues or post ideas for enhancement.
+
+Join our `webexteamssdk - Webex Teams SDK - Python Community Contributors <https://eurl.io/#BJ0A8gfOQ>`_ Webex Teams space to join the conversation with other contributors to this project.
+
+
+
+Interested in Contributing Code?
+================================
+
+
+Developer Scripts
+-----------------
+
+We have created some scripts to automate everyday actions needed when working on the project.  Please see the `script`_ directory, and it's README for more information.
+
+
+Notes on the Test Suite
+-----------------------
+
+To test all the API endpoints, the account that you use for testing must be an *admin* user for your Webex Teams Organization.  Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite. We strongly recommend *NOT* running the test suite using your personal Webex Teams account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).
+
+If you cannot create a test account with *admin* privileges or configure your environment to run the test suite locally, you may always submit your code via a pull request.  Our GitHub/Travis CI setup runs the test suite against all pull requests.  All tests must pass before your pull request is accepted.
+
+
+Contributing Code - Using the CI Automated Testing
+--------------------------------------------------
+
+1. Check for open `issues`_ or create a new *issue* for the item you want to work on and make sure to comment and let us know that you are working on it.
+
+2. Fork a copy of the `repository`_ and clone your forked repository to your development environment.
+
+3. Run ``script/setup`` to install the development dependencies and setup your environment.
+
+4. Configure the following environment variables in your development environment:
+
+   * ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
+
+5. Add your code to your forked repository.
+
+   If you are creating some new feature or functionality (excellent!), please also write a `test`_ to verify that your code works as expected.
+
+6. We follow `PEP8`_ reasonably strictly for this project.  Please make sure your code passes the linter.
+
+   Run ``script/test lint`` or simply run ``flake8`` from the project root.
+
+7. Commit your changes.
+
+8. Submit a `pull request`_.  The GitHub/Travis CI system runs the test suite against your pull request code.  If any tests fail, please review your changes.  If everything looks good, we will gladly merge your request!
+
+
+Contributing Code - Running the Test Suite Locally
+--------------------------------------------------
+
+1. Check for open `issues`_ or create a new 'issue' for the item you want to work on and make sure to comment and let us know that you are working on it.
+
+2. Fork a copy of the `repository`_ and clone your forked repository to your development environment.
+
+   Run ``script/setup`` to install the development dependencies and setup your environment.
+
+3. Configure the following environment variables in your development environment:
+
+   * ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
+
+   * ``WEBEX_TEAMS_TEST_DOMAIN`` - The test suite creates some users as part of the testing process. The test suite uses this domain name as the e-mail suffix of for the user's e-mail addresses.
+
+   * ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "[email protected]").
+
+   * ``WEBEX_TEAMS_TEST_FILE_URL`` - Configure this environment variable with a URL referencing a file that can be downloaded and posted to Webex Teams as part of the testing process.
+
+   *Example:*
+
+   .. code-block:: bash
+
+       #!/usr/bin/env bash
+       export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
+       export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
+       export WEBEX_TEAMS_TEST_ID_START=42
+       export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
+
+
+4. Add your code to your forked repository.
+
+   If you are creating some new feature or functionality (excellent!), please also write a `test`_ to verify that your code works as expected.
+
+5. We follow `PEP8`_ reasonably strictly for this project.  Please make sure your code passes the linter.
+
+   Run ``script/test lint`` or simply run ``flake8`` from the project root.
+
+6. Commit your changes.
+
+7. Ensure your code passes all of the default tests.
+
+   Run ``script/test`` and ensure all tests execute successfully.
+
+8. Submit a `pull request`_.  If everything looks good, we will gladly merge your request!
+
+
+.. _script: https://github.com/CiscoDevNet/webexteamssdk/tree/master/script
+.. _issues: https://github.com/CiscoDevNet/webexteamssdk/issues
+.. _repository: https://github.com/CiscoDevNet/webexteamssdk
+.. _test: https://github.com/CiscoDevNet/webexteamssdk/tree/master/tests
+.. _PEP8: https://www.python.org/dev/peps/pep-0008/
+.. _pull request: https://github.com/CiscoDevNet/webexteamssdk/pulls

docs/contributing.rst

@@ -8,22 +8,17 @@ webexteamssdk
 
 -------------------------------------------------------------------------------
 
-Welcome to the docs!  webexteamssdk is a *community developed* Pythonic
-wrapping of the Webex Teams APIs.  The package represents all of the Cisco
-Webex Teams API interactions via native Python tools.  Making working with the Cisco
-Webex Teams APIs in Python a *native* and *natural* experience.
+Welcome to the docs!  webexteamssdk is a *community developed* Pythonic wrapping of the Webex Teams APIs.  The package represents all of the Cisco Webex Teams API interactions via native Python tools.  Making working with the Cisco Webex Teams APIs in Python a *native* and *natural* experience.
 
-**webexteamssdk helps you get things done faster.**  We take
-care of the API semantics, and you can focus on writing your code.
+**webexteamssdk helps you get things done faster.**  We take care of the API semantics, and you can focus on writing your code.
 
 With webexteamssdk, you can easily:
 
 * Interact with the Webex Teams APIs in an interactive Python session
 
 * Quickly create code that enables you get something done in Webex Teams
 
-* Leverage the API wrapper to cleanly add Webex Teams functionality to your project
-  without having to write the boilerplate code for working with the Webex Teams APIs
+* Leverage the API wrapper to cleanly add Webex Teams functionality to your project without having to write the boilerplate code for working with the Webex Teams APIs
 
 To *dive in* and see how webexteamssdk makes your life better, check out the
 :ref:`Quickstart`!
@@ -40,11 +35,17 @@ The User Guide
     user/api
 
 
-The Community Guide
-===================
+The Development Community
+=========================
+
+Interested in contributing to the project?  Please review our community's Code of Conduct and then check out the Contributing page for info to help you get started.
+
+.. toctree::
+    :maxdepth: 1
+
+    code_of_conduct
+    contributing
 
-Community developer docs are *coming soon*.  For now, please see the
-contribution_ instructions on the webexteamssdk_ GitHub page to get started.
 
 
 General Information about the Webex Teams Service
@@ -53,18 +54,15 @@ General Information about the Webex Teams Service
 What is Webex Teams?
 --------------------
 
-    "Webex Teams is where all your work lives.  Bring your teams together in a
-     place that makes it easy to keep people and work connected."
+    "Webex Teams is where all your work lives.  Bring your teams together in a place that makes it easy to keep people and work connected."
+
+Visit the official `Webex Teams`_ website for more information and to create a `free account`_!
 
-Check out the official `Webex Teams`_ website for more information and to
-create a free account!
 
 Webex Teams for Developers
 --------------------------
 
-Leveraging the Webex Teams APIs and developing on top of the Webex Teams cloud
-is easy.  Signup for a `free account`_ and then head over to the
-`Webex Teams for Developers`_ website to learn more.
+Leveraging the Webex Teams APIs and developing on top of the Webex Teams cloud is easy.  Signup for a `free account`_ and then head over to the `Webex Teams for Developers`_ website to learn more.
 
 
 *Copyright (c) 2016-2018 Cisco and/or its affiliates.*