NatLabRockies / NatLabRockies/OpenStudio
<%= taxonomy %> doesn't work in README.md.erb
Open
Nobody has claimed this yet.
component - Measures
resolution - Works As Expected
severity - Minor Bug
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
This isn't a big deal, but if it is an easy fix and if we have to make a new installer anyway, it would be nice to fix. This will the readme.md on the all the updated measures on BCL.
Note: this doesn't error out the process, it just ends up with a blank space on the Readme.md under taxonomy.
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 at openstudiocore/src/utilities/bcl/templates/common/README.md.erb line 17 and inspect how the template is expanded for updated BCL measures. Reproduce the generated README and verify that the taxonomy value appears instead of a blank space without causing the process to error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100