darktable-org / darktable-org/lua-scripts

RFC: Reorganize Lua scripts folders

Open
#639 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
219
Forks
142
PR merge metrics
No merged PRs in 30d

Description

The Lua scripts are currently organized into the following folders

  • contrib - user contributed scripts maintained by the submitter (supposedly)
  • data - used to contain assets required by the scripts
  • examples - example scripts
  • lib - libraries with common code used by all scripts and maintained by the darktable team
  • official - scripts contributed and maintained by the darktable team
  • tools - scripts that make the scripts run and odds and ends - maintained by the darktable team

Lately we've started developing/adding scripts that provide a service such as group_persistence.lua which is designed to add tags to grouped images so that the groups are maintained across database instances and can be reconstructed on import.

The scripts aren't meant to be interacted with, though in some instances they can be through shortcuts.

I propose adding a services folder for these scripts, since that's the purpose of them (providing a service).

Thoughts?


As I started I decided why not fix the whole thing. Below is a tree view of my thinking...

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

Review the current contrib, data, examples, lib, official, and tools folders, along with group_persistence.lua and the proposed services folder. First establish an agreed target organization from the RFC and its follow-up discussion. Done means the folder layout and ownership boundaries are decided and the scripts can be reorganized without breaking their stated uses.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.