Skip to content

Commit 6cc2936

Browse files
committed
Update the contributing doc
Travis tests will not succeed for Pull Requests sent submitted by users other than Chris since Travis hasn't been configured with their Webex Teams access tokens (good security practice). We will make sure the tests pass before pushing a release.
1 parent 467f9a9 commit 6cc2936

File tree

1 file changed

+19
-40
lines changed

1 file changed

+19
-40
lines changed

docs/contributing.rst

Lines changed: 19 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Notes on the Test Suite
3131

3232
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).
3333

34-
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.
34+
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. We will test your code before merging and releasing the changes.
3535

3636

37-
Contributing Code - Using the CI Automated Testing
38-
--------------------------------------------------
37+
Contributing Code
38+
-----------------
3939

4040
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.
4141

@@ -57,54 +57,33 @@ Contributing Code - Using the CI Automated Testing
5757

5858
7. Commit your changes.
5959

60-
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!
61-
62-
63-
Contributing Code - Running the Test Suite Locally
64-
--------------------------------------------------
65-
66-
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.
67-
68-
2. Fork a copy of the `repository`_ and clone your forked repository to your development environment.
69-
70-
Run ``script/setup`` to install the development dependencies and setup your environment.
71-
72-
3. Configure the following environment variables in your development environment:
60+
8. Submit a `pull request`_.
7361

74-
* ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
75-
76-
* ``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.
77-
78-
* ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
79-
80-
* ``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.
8162

82-
*Example:*
63+
Running the Test Suite Locally
64+
------------------------------
8365

84-
.. code-block:: bash
66+
Configure the following environment variables in your development environment:
8567

86-
#!/usr/bin/env bash
87-
export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
88-
export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
89-
export WEBEX_TEAMS_TEST_ID_START=42
90-
export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
68+
* ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
9169

70+
* ``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.
9271

93-
4. Add your code to your forked repository.
72+
* ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
9473

95-
If you are creating some new feature or functionality (excellent!), please also write a `test`_ to verify that your code works as expected.
96-
97-
5. We follow `PEP8`_ reasonably strictly for this project. Please make sure your code passes the linter.
98-
99-
Run ``script/test lint`` or simply run ``flake8`` from the project root.
74+
* ``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.
10075

101-
6. Commit your changes.
76+
*Example:*
10277

103-
7. Ensure your code passes all of the default tests.
78+
.. code-block:: bash
10479
105-
Run ``script/test`` and ensure all tests execute successfully.
80+
#!/usr/bin/env bash
81+
export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
82+
export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
83+
export WEBEX_TEAMS_TEST_ID_START=42
84+
export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
10685
107-
8. Submit a `pull request`_. If everything looks good, we will gladly merge your request!
86+
Ensure your code passes all of the default tests. Run ``script/test`` and ensure all tests execute successfully.
10887

10988

11089
.. _script: https://github.com/CiscoDevNet/webexteamssdk/tree/master/script

0 commit comments

Comments
 (0)