-
-
Notifications
You must be signed in to change notification settings - Fork 13
Add Agents guidelines doc #242
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
megahirt
wants to merge
3
commits into
master
Choose a base branch
from
docs/add-agents-guidelines
base: master
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 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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,16 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Project Structure & Module Organization | ||
| SayMore is a WinForms client targeting .NET Framework 4.6.2. Application code lives in `src/SayMore`, organised by feature folders such as `Model`, `UI`, `Utilities`, and `Transcription`. NUnit fixtures live in `src/SayMoreTests` and mirror the production namespaces; use categories like `SkipOnTeamCity` for fragile tests. Packaging assets sit in `src/Installer` (WiX), while `build/SayMore.proj` drives CI builds and version stamping. Supporting material is stored under `DistFiles` (release notes), `SampleData` (demo content), `artwork` (branding), and `AutoSegmenter` for native helpers. | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| Run `nuget restore SayMore.sln` after cloning to hydrate build tasks and third-party assemblies. Use `msbuild SayMore.sln /p:Configuration=Debug /m` for daily work; binaries land in `output/Debug`. Execute `nunit3-console output/Debug/SayMoreTests.dll --where "cat != SkipOnTeamCity"` to match the TeamCity matrix. Ship-ready builds come from `msbuild build/SayMore.proj /t:Build /p:Configuration=Release`, and installer assets refresh through `build/getDependencies-windows.sh`. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| The root `.editorconfig` enforces tab indentation for `.cs` files; keep braces on new lines in the Visual Studio default style. Stick to PascalCase for types and public members, `_camelCase` for fields, and camelCase locals. Place shared UI controls under the closest `UI/*` folder, and extend existing helpers in `SayMore.Utilities` or `SIL.*` libs before adding new infrastructure. Update localisation through `Resources.resx` so designer files stay generated. | ||
|
megahirt marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Testing Guidelines | ||
| Tests target NUnit 3; annotate fixtures with `[TestFixture]` and name them `<ClassName>Tests`. Express methods as `Method_State_Result` and co-locate helper builders in `SayMoreTests.Utilities`. Tag UI or intermittent tests with `[Category("SkipOnTeamCity")]` so CI filters them automatically. When adding sample files, drop them into `SayMoreTests/Resources` and embed via the generated designer. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| Write imperative, single-sentence commit subjects and reference related JIRA keys (`SP-1234`) when known. Keep logical changes isolated per commit or PR, and avoid bundling installer edits with application logic. Pull requests should summarise motivation, list automated/manual test results, and attach screenshots or sample projects for UI-facing changes. Link the relevant TeamCity build and call out any categories you excluded locally. Request review from a maintainer of the affected module and note follow-up tasks in the PR body. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.