starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Guidance: Contributing.md & Coding Style docs needed #1208

New Issue
Open
opened 2026-01-30 22:19:08 +00:00 by claunia · 0 comments
claunia commented 2026-01-30 22:19:08 +00:00
Owner
Copy Link

Originally created by @dlong11 on GitHub (May 18, 2019).

It would be great if the Windows Terminal Team would provide a contributing.md (Contributing Guide) that would explain the Contribution Workflow, "help wanted", Do's and Don'ts, Commit Messages, etc.

Also adding an official coding style guideline md file would be great. Currently, the CppCoreGuide lines are referenced, but that doesn't give enough guidance around things like

Naming

  • general naming conventions
  • File names
  • Type names
  • Variable names
  • Class names
  • Struct names
  • Constant names
  • Function names
  • Enum names
  • Macro names

Formatting (hopefully clang format gets added and this becomes a non-issue)

  • Line length
  • Spaces vs Tabs
  • braces
  • file types (utf-8, utf-8 BOM, etc...)
  • etc...

maintainer note: we did add clang-format so this kinda is a non-issue

C++ features

  • use of const
  • use of constexpr
  • exceptions
  • friends
  • noexcept
  • casting
  • RTTI
  • auto

Comments

  • Comment style
  • File comments
  • Legal / Copyright
  • Class / Function comments
  • TODO comments
  • etc...

The goal of the style guide should be to describe in detail the dos and don'ts of writing C++ code. (ie -what the Windows Terminal team expects when PRs are submitted) Some of the above are covered in the Cpp Core Guidelines but it would be great to have an official Windows Terminal Guide that explicitly states what the expectations are. The current code doesn't always follow the Cpp Core Guidelines and it is hard to tell if that was on purpose or was just missed when the developer implemented the code.

Good examples of Contributing.md files that could be used as examples / ideas
.Net Core
Opensource guide
React

See also

Originally created by @dlong11 on GitHub (May 18, 2019). <!-- What needs to change? Who is responsible for it? Why is it an open question? --> It would be great if the Windows Terminal Team would provide a contributing.md (Contributing Guide) that would explain the Contribution Workflow, "help wanted", Do's and Don'ts, Commit Messages, etc. Also adding an _official_ coding style guideline md file would be great. Currently, the CppCoreGuide lines are referenced, but that doesn't give enough guidance around things like ### Naming - general naming conventions - File names - Type names - Variable names - Class names - Struct names - Constant names - Function names - Enum names - Macro names ### Formatting (hopefully clang format gets added and this becomes a non-issue) - Line length - Spaces vs Tabs - braces - file types (utf-8, utf-8 BOM, etc...) - etc... _maintainer note: we did add clang-format so this kinda is a non-issue_ ### C++ features - use of const - use of constexpr - exceptions - friends - noexcept - casting - RTTI - auto ### Comments - Comment style - File comments - Legal / Copyright - Class / Function comments - TODO comments - etc... The goal of the style guide should be to describe in detail the dos and don'ts of writing C++ code. (ie -what the Windows Terminal team expects when PRs are submitted) Some of the above are covered in the Cpp Core Guidelines but it would be great to have an official Windows Terminal Guide that explicitly states what the expectations are. The current code doesn't always follow the Cpp Core Guidelines and it is hard to tell if that was on purpose or was just missed when the developer implemented the code. Good examples of Contributing.md files that could be used as examples / ideas [.Net Core](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md) [Opensource guide](https://github.com/github/opensource.guide/blob/master/CONTRIBUTING.md) [React](https://reactjs.org/docs/how-to-contribute.html) --- See also * [ ] #1014 * [ ] #962 * [ ] #887 * [ ] #921 * [ ] #1159
claunia added the Needs-Tag-FixIssue-DocsProduct-MetaArea-BuildArea-CodeHealth labels 2026-01-30 22:19:08 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Build Area-CodeHealth Issue-Docs Needs-Tag-Fix Product-Meta
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#1208
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?