Skip to content

Commit 4ced463

Browse files
committed
Adding examples doc
1 parent cb6547f commit 4ced463

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/Adding_examples.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,23 @@ the example during development and test.
9999
Test that your branch can be downloaded, configured and then
100100
run successfully.
101101

102+
### Add an automated test
103+
Add an automated test for your example.
104+
105+
See the `test` directory for examples.
106+
107+
### Running the tests
108+
109+
````
110+
DS_TEST_ACCESS_TOKEN=1234567... # Tokens are very long
111+
DS_TEST_ACCOUNT_ID=1234567...
112+
export DS_TEST_ACCESS_TOKEN
113+
export DS_TEST_ACCOUNT_ID
114+
npm test
115+
````
116+
102117
## Make a pull request
103-
Make a pull request to for your changes. Your initial pull
118+
Make a pull request for your new example. Your initial pull
104119
request for a new example will probably not be
105120
approved--the examples manager will review your implementation
106121
and will often request changes.

0 commit comments

Comments
 (0)