donnemartin/gitsome

Linux dotfiles, XDG Base Directory

Open

#13 opened on May 10, 2016

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (443 forks)batch import
feature-requesthelp wanted

Repository metrics

Stars
 (7,684 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It would be a good practice if you put all dot files from gitsome in appropriate directory based on the XDG Base Directory specification. Same goes for other operating systems, but unfortunately I'm not familiar what exactly is the best practice there.

As for Linux:

  • configuration files go to $XDG_CONFIG_HOME, which defaults ~/.config/ directory
  • cache files go to $XDG_CACHE_HOME, which defaults ~/.cache/ directory
  • any other files go to $XDG_DATA_HOME, which defaults to ~/.local/share/ directory

Contributor guide

Research direction
Implement XDG Base Directory support for configuration, cache, and data files. Use os.environ.get with defaults for XDG CONFIG HOME, XDG CACHE HOME, XDG DATA HOME.
Tech stack
python
Domain
clideveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70