docs: update contributing guidelines and enhance README with build in…#123
Merged
Conversation
…structions and architecture overview
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the repository’s contributor-facing documentation by expanding the README into a more informative landing page and rewriting CONTRIBUTING.md to provide clearer onboarding and development guidance.
Changes:
- Expanded
README.mdwith a richer introduction, a demo GIF, build/test instructions, and a high-level architecture section. - Rewrote
CONTRIBUTING.mdto better explain contribution paths, dev setup, repo structure, and PR/CI expectations.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a more detailed project overview plus build/test steps and an architecture section for new contributors. |
| CONTRIBUTING.md | Modernizes and expands contribution guidance, including setup steps, architecture outline, and CI notes. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
mkrueger
approved these changes
Jun 10, 2026
Contributor
|
Thanks |
…ributor-experience # Conflicts: # CONTRIBUTING.md
sevoku
approved these changes
Jun 15, 2026
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.
Revamps the repo's landing page (README) and contributor guide to lower the barrier for new contributors and make the project more inviting.