[FEAT]: Developer setup guide and enhanced CONTRIBUTING.md#245
Open
kasimlohar wants to merge 2 commits intofireform-core:mainfrom
Open
[FEAT]: Developer setup guide and enhanced CONTRIBUTING.md#245kasimlohar wants to merge 2 commits intofireform-core:mainfrom
kasimlohar wants to merge 2 commits intofireform-core:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive developer onboarding guide and expands contribution guidelines to reduce repeated setup issues for new contributors.
Changes:
- Introduces
docs/SETUP.mdwith cross-platform setup steps, test commands, environment variables, and common troubleshooting notes. - Expands
CONTRIBUTING.mdwith quick-start instructions, testing guidance, branch naming, commit conventions, and a project structure overview.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/SETUP.md | New end-to-end developer setup guide (Docker + local) with troubleshooting and architecture overview. |
| CONTRIBUTING.md | Enhanced contributor guidance: setup quick starts, testing, branching/commits, and repo structure. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Description
Enhances the existing
CONTRIBUTING.mdwith developer setup instructions,testing commands, branch conventions, and project structure overview. Adds a
new comprehensive
docs/SETUP.mdwith cross-platform setup guide, commonerror solutions, and architecture overview.
New contributors frequently face setup issues (#77, #184, #191, #204, #224).
This PR consolidates solutions in one place.
Fixes #244
Type of change
How Has This Been Tested?
Documentation-only changes — no code is modified. Verified that:
Test Configuration:
Checklist: