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

Ouverte
#369 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
git, python

Piste de recherche

Commencez par inspecter le .gitignore du dépôt et repérer où les thèmes et config.yaml sont chargés ou générés. Définissez le périmètre avec le maintainer avant de modifier quoi que ce soit : le travail sera terminé lorsque les thèmes et les paramètres utilisateur survivront à un git pull, tout en conservant un chemin clair vers la configuration par défaut.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement

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.

Langage dominant
Rich Text Format
Étoiles
2.3k
Forks
412
Merge moyen
21 h 10 min
PR mergées (30 j)
7

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de mathoudebine/turing-smart-screen-python

Toutes les issues de mathoudebine/turing-smart-screen-python

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.