Confierge should write readme in config cache directory

Open Beginner friendly
#87 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Locate the code that creates or manages Confierge's config cache directory and inspect how its contents are written. Add a small README.md explaining that the directory is managed by Confierge and should not be edited directly. Done when the explanatory markdown file is written into that cache directory and existing tests pass.

Written by the indexing model from the issue text.

Description

Since the config cache directory is managed by confierge, we wouldn't want people finding that directory and thinking they can change configuration files. Confierge should just write a little markdown file explaining how it works.

Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AllenNeuralDynamics/ficus

All issues in AllenNeuralDynamics/ficus

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.