A repo for examples for the FEO Python client.
Status: Required by default, optional for documentation repositories.
Requirements:
- Code block illustrating how to install.
Subsections:
Dependencies. Required if there are unusual dependencies or dependencies that must be manually installed.
Suggestions:
- Link to prerequisite sites for programming language: npmjs, godocs, etc.
- Include any system-specific information needed for installation.
- An
Updatingsection would be useful for most packages, if there are multiple versions which the user may interface with.
Status: Required by default, optional for documentation repositories.
Requirements:
- Code block illustrating common usage.
- If CLI compatible, code block indicating common usage.
- If importable, code block indicating both import functionality and usage.
Subsections:
CLI. Required if CLI functionality exists.
Suggestions:
- Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here.
- If relevant, point to a runnable file for the usage code.
Status: Required.
Requirements:
- State where users can ask questions.
- State whether PRs are accepted.
- List any requirements for contributing; for instance, having a sign-off on commits.