The-Strategy-Unit / The-Strategy-Unit/data_science

Explain our preferred use of env vars

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

Nobody has claimed this yet.

section: style guide
Dominant language
Jupyter Notebook
Stars
11
Forks
5
Avg merge
5h 34m
Merged PRs (30d)
1

Description

We state in a couple of places that we use .Renviron and .env env vars, though these are in presentations. A few READMEs suggest copying and completing an .Renviron.example template, for example. Make it clear in 'how we work' what our preferences are, e.g. that these should live in the project not at global level.

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.

Research direction

Find the “how we work” guidance, the referenced READMEs, and the presentations that mention .Renviron or .env; read the existing .Renviron.example instructions first. Update the documentation so the preferred project-level rather than global placement of environment variables is explicit, and confirm the guidance is consistent across those references.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.