Mention git ignored dev conf file in developer documentation
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 8
Description
`CMEW/opt/rose-suite-dev.conf` is on `.gitignore`'s list, so developers can set their own config and type "cylc vip -O dev" to use these settings.
It should probably be documented somewhere.
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
Search the developer documentation and repository references to `.gitignore` for the best location to explain `CMEW/opt/rose-suite-dev.conf`. Document that developers can provide their own configuration and use it with `cylc vip -O dev`; done means a developer can discover and follow this workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100