RMI / RMI/practices

How to handle application configuration

Open
#19 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

wontfix
Dominant language
No language data
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Come to a consensus on how we as a team would like to handle application configuration.

Some methods (all live in our current repos)

  • A series of Sys.getenv() calls (often used with docker-compose.yml or azure-deploy.json)
  • Passing in a JSON file (jsonlite)
  • Passing in a YAML file (config)
  • defining behavior in an .env file (dotenv)
  • defining behavior in an .env file (base::readRenviron())

While there is some space for variation, having a general strategy team-wide would help make onboarding to a new project/codebase easier.

Contributor guide

Open the contributing guide

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

Start by comparing the configuration approaches listed in the issue, including Sys.getenv(), jsonlite, config, dotenv, readRenviron(), docker-compose.yml, and azure-deploy.json, across the current repositories. The work is done when the team reaches a general configuration strategy and records it clearly enough to support onboarding.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, docker-compose, r
Domain
developer-experience, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.