microsoft / microsoft/vscode-cpptools

DOCUMENTATION REQUEST: Version Control Files

Aperta
#11,019 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs Language Service
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

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?

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 con la documentazione esistente del repository e con gli esempi .vscode/user_filename e .vscode/${USER}/anyfileyouwant descritti nell’issue. Documenta quali impostazioni di progetto e utente di VS Code debbano essere sottoposte a commit o escluse, e fornisci indicazioni sui file .gitignore nei progetti misti C e Python basati su Makefile.

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

Valutazione

Stack tecnologico
c, python, vscode
Ambito
developer-experience, documentation, tooling
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.