mathoudebine / mathoudebine/turing-smart-screen-python

Use gitignore so common end user modifications don't prevent git pull

Aperta
#369 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Rich Text Format
Stelle
2.3k
Fork
412
Merge medio
21h 10m
PR unite (30g)
7

Descrizione

Describe the feature / solution to your problem you'd like
Please have a folder for themes that are included by default, and another folder for themes that we might create ourselves or get from other sources. Please add this folder to the gitignore file so that we can pull down newer versions of the repository without needing to copy our themes out of the folder and add them back in after pulling down changes.

A related challenge would be to, upon first run, generate a config.yaml copy (userconfig.yaml?) that is actually used for storing settings, and having that config file be in the gitignore. That way, the user might run the script for the first time and have a config file generated for them, but since that would be in the gitignore, they would still be able to get changes. The config.yaml right now might be renamed to config.yaml.template to show that it is used for the generation of a config file.

Ideally, files that are commonly modified by end users would be in the gitignore, but there should be an option for an initial config to be generated in the absence of a user config.

Describe alternatives you've considered / and or tested
Currently, I use a PowerShell script to move my theme and config out of the directory, and move them back into the repo after pulling down the changes.

Screenshots / photos & mockups of the Turing screen
Here is an example of files I need to move out before I can pull the latest code down:

image

Environment:

  • Revision of this project [main branch]
  • OS with version [Windows 11]
  • Python version [python 3.11]
  • Hardware [AMD Ryzen 7950x3D, GeForce RTX 4090, 128GB RAM]

Additional context
These changes should encourage tinkering, and encourage updates to the latest version.
Those that have issues after downloading the latest updates should consider clearing their personal settings file in case the format changes and they need to pull the latest version.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia ispezionando il .gitignore del repository e individuando dove vengono caricati o generati i temi e config.yaml. Definisci l'ambito con il maintainer prima di modificare qualsiasi cosa: il lavoro sarà completato quando i temi e le impostazioni dell'utente sopravvivranno a un git pull, mantenendo al contempo un percorso chiaro per la configurazione predefinita.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
git, python
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.