microsoft / microsoft/vscode-cpptools

DOCUMENTATION REQUEST: Version Control Files

Offen
#11,019 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs Language Service
Vorherrschende Sprache
TypeScript
Sterne
6.2k
Forks
1.7k
Ø Merge
14 Std. 46 Min.
Gemergte PRs (30 T.)
61

Beschreibung

Feature Request

I can't use solutions like PlatformIO - for any number of reasons.

My builds are always "Makefile based" - and include some standard targets, like: "make clean" and "make all" but there are others like "make tables" that run various python scripts to generate data tables. We use GNU tools, but they are not in your $PATH - for any number of reasons. the primary reason is each project must remain "locked" to a very specific and validated compiler and it will never change. {I have 10 different versions of GCC for ARM installed - and have about 25 active projects across my team}. All of this is handled in our Makefiles in one way or another.

What is not clear is this:
what VSCODE files should be checked in to GIT and shared?
Where is this documented?

Likewise:
what about a standardized ".gitignore" file for each language/project type?
NOTE: In my case I have mixed projects, C and Python projects.

USER SETTINGS - I have (N) people working on a project. We do not want to stomp on each others personalization's and do not want to recreate every time..
What files like these should we exclude from GIT, which ones should we include?
Where is this documented?

NOTE: If files are personalized by name we can check them in.
But they need to be uniquely named, or in a user specific directory.
Generically named personalized files are a big/huge problem.

Example: ${PROJ}/.vscode/user_filename <- This is bad
But: ${PROJ}/.vscode/${USER}/anyfileyouwant <- This is good, it is unique to user.
NOTE: this needs to be in the project, not in the users home directory.
Why? Because I do not want 10 different people working an stomping on each others configurations.
Where is this sort of stuff documented?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der vorhandenen Dokumentation des Repositorys und den in der Aufgabe beschriebenen Beispielen .vscode/user_filename und .vscode/${USER}/anyfileyouwant. Dokumentieren Sie, welche VS Code-Projekt- und Benutzereinstellungen committet oder ausgeschlossen werden sollten, und geben Sie Hinweise zu .gitignore-Dateien in gemischten C- und Python-Projekten auf Makefile-Basis.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c, python, vscode
Bereich
developer-experience, documentation, tooling
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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