You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* add deprecation module to requirements file.
used new file to create new conda and non-conda venvs
ran unit tests in new venvs to ensure they passed.
* made several changes to setup instructions.
tested the instructions for conda and nonconda venvs
tests expected to pass with API key did
* docs: python version requirement
* docs: formatting, python version req, standard sample env name/path
Co-authored-by: Clayton Davis <[email protected]>
Co-authored-by: Saumil Dave <[email protected]>
Co-authored-by: saumil-d <[email protected]>
@@ -102,12 +124,15 @@ Fix that bug or build your feature.
102
124
103
125
=== 3. Run unit tests
104
126
105
-
Configure the environment variables to easily run all the tests with a single configuration point.
127
+
Configure the environment variables to easily run all the tests with a single configuration point.
128
+
Note that the environment variables must be set before opening the terminal or program that you will be running your tests from. Environmental variables do not update on the fly.
106
129
107
130
You can:
108
131
109
132
==== Set environment variables in bash
110
-
133
+
There are 2 environmental variables that the test scripts will need.
134
+
MODZY_BASE_URL: This variable holds the network address of the modzy installation. Notice the '/api' appeanded to the end of the url. This is mandatory and will cause errors if not present.
135
+
MODZY_API_KEY: This variable holds a full copy of a modzy API key. Modzy's role based access controls will cause some of the tests to fail if your key doesn't have all the roles assigned.
111
136
===== Windows
112
137
113
138
[source,bash]
@@ -146,7 +171,7 @@ Or specify the test that you want to run:
146
171
147
172
Add supporting documentation for your code.
148
173
149
-
//what else would be useful for Raúl?
174
+
//what else would be useful for maintainers?
150
175
151
176
=== 5. Send a pull request
152
177
@@ -160,6 +185,9 @@ Push your branch to GitHub:
160
185
161
186
- `$ git push origin my-new-awesome-feature`
162
187
188
+
Initiate a Pull Request:
189
+
190
+
If your PR doesn't pass all tests due to role based access controls with your key, please provide log information so that we may test the PR under appropriate conditions.
0 commit comments