docs: add CONTRIBUTING.md with setup, build, and PR workflow (closes #12)#326
Open
feng83232 wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md with setup, build, and PR workflow (closes #12)#326feng83232 wants to merge 1 commit into
feng83232 wants to merge 1 commit into
Conversation
- Covers local development setup instructions - Lists required tools and minimum versions - Describes PR workflow: fork -> branch -> commit -> PR - Links to .github/pull_request_template.md - Mentions inclusion of diagnostic artifacts in PRs - Includes code style guidance (no .editorconfig found) - Adds real diagnostic artifacts from build.py run Closes lobster-trap#12
Owner
|
Diagnostics are still blocking review on this PR. Please rebase onto the current upstream branch and run the repository build script so the script-generated diagnostic bundle is committed to this PR: git fetch upstream
git rebase upstream/main
python3 build.py
git push --force-with-leasePlease do not manually create, copy, or edit diagnostic files. A valid PR must include a matching |
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.
Summary
Adds CONTRIBUTING.md to the repo root documenting how to set up the development environment, build using
python3 build.py, and submit pull requests. Closes issue #12.Changes
CONTRIBUTING.md— new file with local setup instructions, required tools, build commands, PR workflow, code style guidance, and reference to the PR templatediagnostic/build-00000000.jsonand.logd— removed (replaced by real diagnostic artifacts)diagnostic/build-3774a0c8.jsonand.logd— added (real diagnostic build output frompython3 build.py)Testing
Ran
python3 build.py— timed out at 60s as expected (limited toolchain in this environment). Generated real diagnostic artifacts.Checklist