Skip to content

docs(contributing): add quick-start demo asset to onboarding guide#374

Open
techAlhaji wants to merge 4 commits into
tributary-protocol:mainfrom
techAlhaji:docs/contributing-demo-assets
Open

docs(contributing): add quick-start demo asset to onboarding guide#374
techAlhaji wants to merge 4 commits into
tributary-protocol:mainfrom
techAlhaji:docs/contributing-demo-assets

Conversation

@techAlhaji

Copy link
Copy Markdown

Summary

Closes #146

Adds a visual onboarding asset demonstrating the basic contributor workflow (clone → test → demo) and links it from CONTRIBUTING.md to help first-time contributors get started more quickly.


What Changed

🎥 Quick-Start Demo Asset

Added a visual asset illustrating the typical contributor workflow:

  1. Clone the repository
  2. Install dependencies
  3. Run tests
  4. Build the project
  5. Launch the demo/application

The asset provides a quick reference for new contributors before they begin making changes.


📚 CONTRIBUTING.md

Updated CONTRIBUTING.md to include:

  • A link to the quick-start demo asset
  • A short description of what the demo covers
  • Guidance for first-time contributors on where to begin

Benefits

  • Improves the onboarding experience for new contributors
  • Reduces setup confusion
  • Provides a visual reference alongside written instructions
  • Makes the contribution workflow easier to follow

Testing

Documentation-only change.

No application behavior or contract logic was modified.


Checklist

  • Added onboarding/demo asset
  • Linked asset from CONTRIBUTING.md
  • Documentation reviewed for clarity
  • No functional code changes
  • CI checks remain green

@techAlhaji
techAlhaji requested a review from Spagero763 as a code owner July 23, 2026 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a short screencast of the dev loop to CONTRIBUTING

1 participant