Correct and clean up developer setup documentation - #1124
Open
papeh wants to merge 6 commits into
Open
Conversation
* Fix instructions for reporting bugs * Consolidate redundant sections in CONTRIBUTING and core-developer-setup * Suggest a private email address for git config * Clarify requirements for installer, FlexBridge, and Paratext work TODO: figure out WiX requirements
* Move git config instructions to CONTRIBUTING.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1124 +/- ##
=======================================
Coverage 38.57% 38.58%
=======================================
Files 1514 1514
Lines 351014 351014
Branches 40355 40355
=======================================
+ Hits 135418 135432 +14
+ Misses 186380 186368 -12
+ Partials 29216 29214 -2 🚀 New features to boost your workflow:
|
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
papeh
marked this pull request as ready for review
September 4, 2026 18:44
papeh
marked this pull request as draft
September 4, 2026 19:20
papeh
marked this pull request as ready for review
September 4, 2026 19:35
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation was out of sync with reality (both ahead and behind). Correct documentation and remove redundant documentation.
CI-ready checklist
(https://github.com/sillsdev/FieldWorks/blob/main/.github/commit-guidelines.md).
As much as possible, the change is unit tested.Builds & tests pass locally (or I've run the CI-style build viabuild.ps1,test.ps1, or MSBuild).Docs/workflows/ai-pr-workflow.mdand ranpr-preflightor the equivalent branch-readiness review before requesting review.For anySrc/**folders touched, correspondingAGENTS.mdfiles are updated or explicitly confirmed still accurate.Reading this a year from now -- start here
This PR is a documentation correction and de-duplication pass across
Docs/CONTRIBUTING.mdandDocs/core-developer-setup.md. There's no code behind it and no research artifact was produced or deleted — the reasoning below is all there is.Decisions, and why
CONTRIBUTING.mdand removed fromcore-developer-setup.md, with a cross-reference left behind instead of silently dropping it.Evidence
git diff --name-status origin/main...HEAD -- '*.md'shows exactly the two files touched:Docs/CONTRIBUTING.md,Docs/core-developer-setup.md.Setup-Developer-Machine.ps1,Build/Agent/Setup-DefenderExclusions.ps1,Build/Agent/Verify-FwDependencies.ps1,Build/Agent/Setup-InstallerBuild.ps1,Docs/workflows/ai-pr-workflow.md,Docs/visual-studio-setup.md,Docs/installer-build-guide.md,Docs/vscode-stability-profile.md,.github/instructions/build.instructions.md,.github/commit-guidelines.md,Docs/workflows/pull-request-workflow.md,Docs/workflows/release-process.md,DistFiles/Graphite/pl/piglatin.ttf,build.ps1,test.ps1.CONTRIBUTING.md's "Git Configuration Reference" section before deleting it fromcore-developer-setup.md(it had been stated three times across the two files).Reviewable
This change is
Co-authored-by: Claude Sonnet 5 noreply@anthropic.com