KhronosGroup / KhronosGroup/COLLADA-CTS

Configuration files shouldn't be in repository

Open
#3 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
34
Forks
12
PR merge metrics
No merged PRs in 30d

Description

I think the config.txt file in the root of the repository should be renamed to something like config.example.txt. Generally, configuration files should not be checked in with their actual name, because then changing them in your checked out copy makes the file show as dirty, and people might accidentally commit changes to the default example config file.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with config.txt in the repository root and inspect the repository for references to that filename. Rename it to an example configuration filename such as config.example.txt, update any affected references, and verify that the actual configuration can be changed locally without making the example file appear modified.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.