microsoft / microsoft/terminal

AddASetting.md does not appear to be up-to-date

Open
#20,550 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Settings Issue-Docs Product-Terminal
Dominant language
C++
Stars
105k
Forks
9.6k
Avg merge
3d 17h
Merged PRs (30d)
29

Description

### Description of the new feature

I am trying to implement issue #6820 and am using AddASetting.md to do so. However, when trying to follow the instructions I notice that the instructions don't seem to match existing elements. The instructions say to declare the setting in Profile.h (or in my case, GlobalAppSettings.h), but the settings seem to be defined in Profile.idl instead, and the lines of code the instructions say to add to Profile.idl don't seem to be present for any other settings in that file.

I would like this implementation to not simply work but follow the design practices of the existing window settings. Is this guide out-of-date, and if it isn't why is the guide's implementation so different from the existing implementations?

### Proposed technical implementation details

_No response_

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 reading AddASetting.md and compare its instructions with the existing definitions in Profile.idl and the references to Profile.h and GlobalAppSettings.h. Use the window settings related to issue #6820 as the comparison point. Done means the guide accurately reflects the current implementation and design practices, or clearly explains why the documented process differs.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.