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

CHEFS examples lack consistency #3

Open
1 task
WalterMoar opened this issue Dec 8, 2023 · 0 comments
Open
1 task

CHEFS examples lack consistency #3

WalterMoar opened this issue Dec 8, 2023 · 0 comments

Comments

@WalterMoar
Copy link
Collaborator

WalterMoar commented Dec 8, 2023

The example forms in CHEFS lack consistency in:

  • name of the .JSON files that can be downloaded (chefs_example__something_something.json?)
  • code shown in the documentation must match what is in the JSON files
  • JSON files must match what is deployed in CHEFS
  • CHEFS examples should only be owned by CHEFS team
  • Examples should not produce console errors, even if it means the JavaScript is more complicated. When less technical users cut and paste from the examples it's more difficult to help them debug if the console is full of errors.

Definition of Done

  • Update the Style Guide with a description of the naming convention (and anything else) related to examples
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