Skip to content

Commit

Permalink
add note about using SDK creds to README
Browse files Browse the repository at this point in the history
  • Loading branch information
EronHennessey committed Feb 1, 2017
1 parent a52c093 commit 8a2a8ec
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ documentation.
* **Make sure that the code can be built and run**. There's nothing more frustrating in developer
documentation than code examples that don't work. Build the code and test it before submitting it!

* **Do not include personal account data, keys or IDs in your examples**. Code should obtain access
keys from the standard SDK credentials and config files, use environment variables or external
data files, or query the user for this information.

* **Format code lines to 80 characters**. Long lines can be enclosed in a scrollable box for HTML,
but in a PDF build, long lines will often spill off of the side of the page, making the code
unreadable. If your code includes long text strings, consider breaking these into smaller chunks
Expand Down

0 comments on commit 8a2a8ec

Please sign in to comment.