NatLabRockies / NatLabRockies/COMPASS
Include "in the works" section in the Readme
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 4
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 17
Description
COMPASS version checks
- I have checked that the issue still exists on the latest versions of the docs on
mainhere
Location of the documentation
https://github.com/NatLabRockies/COMPASS/blob/main/README.rst
Documentation problem
I think it will be good to add a Upcoming or similar section in the Readme about the plugins/features/datasets being developed/produced and tentative timeline.
Suggested fix for documentation
Upcoming Dataset
- U.S. Wind Siting Regulation and Zoning Ordinances 2026 - Tentative October, 2026
- U.S. Solar Siting Regulation and Zoning Ordinances 2026 - Tentative October, 2026
- ...
Upcoming Plugins
- ...
Contributor guide
No contributing guide indexed for this repository
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
Open README.rst at the location given in the issue and review its existing section structure. Confirm which upcoming datasets, plugins, features, and tentative timelines should be listed, then add an appropriately placed section. Done means the README includes the agreed upcoming work without presenting tentative dates as commitments.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 56/100