-
Notifications
You must be signed in to change notification settings - Fork 84
* Add find-msbuild helper and update build scripts (V85 LTS) #3791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PWagner1
wants to merge
1
commit into
V85-LTS
Choose a base branch
from
V85-LTS-3788-feature-request-allow-the-build-script-to-find-visual-studio
base: V85-LTS
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Environment | ||
| - OS: Windows | ||
| - Shell: Use Command Prompt (`cmd.exe`) only; avoid Bash/Unix commands | ||
| - Tools: Visual Studio 2022 (v17) and appropriate .NET SDKs starting with `net472` | ||
| - Build scripts are Windows `.cmd` files under `Scripts/` | ||
| - Do not run build scripts unless instructed to do so | ||
|
|
||
| ## Project Structure & Module Organization | ||
| - `Source/Krypton Components`: Core libraries (`Krypton.Toolkit`, `Krypton.Ribbon`, `Krypton.Navigator`, `Krypton.Workspace`, `Krypton.Docking`) and the solution `Krypton Toolkit Suite 2022 - VS2022.sln` | ||
| - `Source/Krypton Components/TestForm`: WinForms sample app used to validate changes | ||
| - `Source/TestHarnesses`: Small repro/test harnesses (e.g., `ThemeSwapRepro`) | ||
| - `Scripts/`: Build and packaging scripts (`build-stable.cmd`, `build-canary.cmd`, `build-nightly.cmd`, `build.proj`) | ||
| - `Bin/`: Build outputs by configuration (e.g., `Bin/Debug`) | ||
| - `Documents/`, `Assets/`, `Logs/`: Docs, images, and build logs | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| - Build solution (Debug): | ||
| - `dotnet build "Source/Krypton Components/Krypton Toolkit Suite 2022 - VS2022.sln" -c Debug` | ||
| - Run sample app: | ||
| - `dotnet run --project "Source/Krypton Components/TestForm/TestForm.csproj" -c Debug` | ||
| - Preset builds (Windows cmd): | ||
| - `Scripts/build-stable.cmd` | `Scripts/build-canary.cmd` | `Scripts/build-nightly.cmd` | ||
| - Build scripts locate MSBuild via `Scripts\Common\find-msbuild.cmd` (`vswhere.exe`, then standard install paths). Profiles: `2019`, `2022`, `current` (newest VS major 18+), or a pinned major (`18`, `19`, …). `Scripts\Current\` uses `current`. Override with `MSBUILDPATH` or `MSBUILD_PATH` pointing at `MSBuild\Current\Bin`. | ||
| - Outputs land in `Bin/<Configuration>/`. VS2019/full MSBuild builds only .NET Framework 4.x TFMs; supported TFMs include `net472`, `net48`, `net481`, `net8.0-windows`, `net9.0-windows`, `net10.0-windows` | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Line endings/encoding: CRLF, UTF-8 with BOM | ||
| - Follow `Source/.editorconfig` and project analyzers (`EnableNETAnalyzers=true`) | ||
| - Indentation: 4 spaces; line endings: CRLF | ||
| - Projects use `global using` like in GlobalDeclarations.cs, do not add new usings in other files | ||
| - Before adding new variables check for existing ones | ||
| - No variable aliasing | ||
| - New files must use only the current Standard Toolkit BSD header. Do not add the original ComponentFactory BSD header unless the file is derived from original ComponentFactory source. | ||
|
|
||
| ## C# Rules | ||
| - Surgical edits: preserve structure, identifiers, and existing comments; avoid adding defensive checks unless asked | ||
| - No unneeded `try/catch` blocks if there's no catch handling | ||
| - Idioms: use null-propagation and object/collection initializers where consistent | ||
| - Fix compiler, analyzer, and IDE warnings in new or modified code before handing work back | ||
| - Prefer switch expressions for simple value/type dispatch that only returns a value; keep switch statements for complex control flow or side effects | ||
| - Compatibility: ensure changes build for `net472` and C# 7.3 | ||
| - WinForms: `UseWindowsForms=true`; prefer designer-friendly patterns and keep partial classes tidy | ||
| - WinForms designer: keep object declarations at file bottom; initialize in `*.Designer.cs` `InitializeComponent()` | ||
| - Constraint: do not use `yield return` inside `catch` blocks | ||
|
|
||
| ## Testing Guidelines | ||
| - No formal unit test suite. Validate changes via `TestForm` scenarios and harnesses under `Source/TestHarnesses` | ||
| - When fixing a bug, add/adjust a minimal repro in `TestForm` or a harness and describe manual steps in the PR | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Commits: short, imperative subject; reference issues/PRs (e.g., `Fix autosizing (#2433)` or `2439 V100 datecell autosizing`) | ||
| - PRs: clear description, linked issues, screenshots/gifs for UI changes, notes on breaking changes/TFM impact | ||
|
|
||
| ## Security & Configuration Tips | ||
| - Windows long paths must be enabled to build locally (see README link). Build on Windows for `-windows` TFMs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AGENTS.md shouldn't be in this PR