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

Offen
#369 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
git, python
Bereich
developer-experience, tooling

Rechercherichtung

Beginne mit der Prüfung der .gitignore des Repositorys und ermittle, wo Themes und config.yaml geladen oder generiert werden. Kläre den Umfang mit dem Maintainer, bevor du etwas änderst: Erledigt ist die Aufgabe, wenn Benutzerthemes und -einstellungen einen git pull überstehen und gleichzeitig ein klarer Pfad für die Standardkonfiguration erhalten bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Rich Text Format
Sterne
2.3k
Forks
412
Ø Merge
21 Std. 10 Min.
Gemergte PRs (30 T.)
7

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus mathoudebine/turing-smart-screen-python

Alle Issues in mathoudebine/turing-smart-screen-python

Ähnliche Issues

Weitere Issues zu DevTools

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.