Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Methodology for examples #32

Open
4 tasks
maxkoryukov opened this issue Feb 4, 2017 · 1 comment
Open
4 tasks

Methodology for examples #32

maxkoryukov opened this issue Feb 4, 2017 · 1 comment
Assignees

Comments

@maxkoryukov
Copy link
Contributor

maxkoryukov commented Feb 4, 2017

There will be more than 100 examples.

I want to keep them all:

  1. up to date (read: every example should be testable with mocha)
  2. concise (as few extra code in each sample as possible)

And another one requirement: there should be an easy way to include examples to doc (and to samples on off.site)

Requirements for example-sources

  • clean folder structure
  • easy testable (should be included as test suite for mocha)
  • concise and understandable for end-users of SDK
  • one of the following must be true:
    • example must not contain extra code
    • example must be post-processed to include in documentation
@maxkoryukov maxkoryukov self-assigned this Feb 4, 2017
@maxkoryukov maxkoryukov added this to the 1.1.0 docs and improvements milestone Feb 4, 2017
maxkoryukov added a commit that referenced this issue Feb 5, 2017
@maxkoryukov maxkoryukov modified the milestones: 0.3.0 docs and examples, x.x.x-examples Feb 17, 2017
@maxkoryukov maxkoryukov mentioned this issue Apr 6, 2017
4 tasks
@maxkoryukov
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant