platformio / platformio/platformio-core

Please allow disabling automatic .gitignore generation; or any arbitrary .tpl file

Open
#4,181 10 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement integration
Dominant language
Python
Stars
9.5k
Forks
905
Avg merge
2d 13h
Merged PRs (30d)
2

Description

My platformIO projects generally live in a subfolder of a larger .git repository.
I prefer to manage a single .gitignore file in the root of my repository.

PlatformIO insists upon re-generatng the .gitignore file. I'd like to be able to turn this off.

This subject is discussed here:
https://community.platformio.org/t/how-to-disable-auto-generating-gitignore-when-using-vscode/17125

Where @maxgearhardt helpfully detailed the technical reasons for this. He suggests a more general solution might be to allow disabling any .tpl file.

-Matt

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 by tracing where PlatformIO generates .gitignore and other .tpl files, using the technical discussion linked in the issue for context. Determine how a project could disable automatic .gitignore generation or arbitrary templates; done means the selected files are no longer regenerated while existing generation remains unchanged by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.