eclipse-thingweb / eclipse-thingweb/td-tools

Enhance CodeGen README

Open Beginner friendly
#83 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
6
Forks
11
Avg merge
1d 15h
Merged PRs (30d)
4

Description

Besides working examples (see https://github.com/eclipse-thingweb/td-tools/pull/82) I suggest adding what are the prerequisites, what file do I need to store and what to run to make it bulletproof. Similar to what we have in node-wot (see https://github.com/eclipse-thingweb/node-wot/blob/master/packages/binding-http/README.md#client-example)

Moreover, I am not exactly sure how I can run the CI. In my quick test I failed.

Contributor guide

Open the contributing guide

Research direction

Start with the CodeGen README and compare its examples with the working example in pull request #82 and the client example in node-wot's binding-http README. Document prerequisites, the Thing Description file to store, commands to run, and how to run CI; done means a newcomer can follow the README successfully and the CI steps are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.