NatLabRockies / NatLabRockies/OpenStudio
Design feature for OS CLI to use measure from extension gem
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Create a design document detailing how measures which use extension gem functionality can be used in CLI. Basic idea is to add Gemfile to OSW (either as link or embedded). Does user have to create Gemfile? Is Gemfile populated by looking at Measures and collecting their requirements? What happens if you put Measures with incompatible gem requirements in a workflow?
Design should also cover how Gemfile is associated with an OSA.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the OS CLI handles OSW workflows, Measures, and OSA association, then examine how extension gem requirements are represented. The design document should explain Gemfile ownership and population, incompatible gem requirements, and how the Gemfile is associated with an OSA.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100