microsoft / microsoft/vscode-cpptools

DOCUMENTATION REQUEST: Version Control Files

Open
#11,019 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs Language Service
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository's existing documentation and the .vscode/user_filename and .vscode/${USER}/anyfileyouwant examples described in the issue. Document which VS Code project and user settings should be committed or excluded, and provide guidance for .gitignore files in mixed C and Python Makefile-based projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python, vscode
Domain
developer-experience, documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.