NatLabRockies / NatLabRockies/GridAnalysisToolkit
Add CITATION.cff and CONTRIBUTING.md
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Standard community files for a lab open-source release:
- CITATION.cff so the repo gets GitHub's 'Cite this repository' box (include the SWR-25-41 software record reference)
- CONTRIBUTING.md formalizing what the README's Contributing section sketches: PR workflow (main is PR-only for non-admins with 1 approval), dev/doc extras installation, how test fixtures work (bring-your-own PLEXOS data,
make sienna-fixture-v4)
While in there: sync pyproject.toml's description with the repo About text ('unified Python API and plotting for power system PCM and CEM results').
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
Start with the README's Contributing section, then inspect pyproject.toml and the repository metadata. Add CITATION.cff with the SWR-25-41 reference, expand CONTRIBUTING.md to cover PR approvals, extras, and PLEXOS fixture setup including make sienna-fixture-v4, and sync the pyproject description with the About text. Done means all requested files and instructions are present and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100