feat: developer experience and CI improvements (#347 #348 #349 #357)#613
Merged
Mystery-CLI merged 2 commits intoMay 30, 2026
Merged
Conversation
…thereal-Future#348 Ethereal-Future#349 Ethereal-Future#357) - Add CONTRIBUTING.md with prerequisites, local setup, test commands, testnet instructions, and PR review process (Ethereal-Future#347) - Expand backend/.env.example with inline docs for every variable, marking each required/optional with examples for PLATFORM_FEE_ACCOUNT_SECRET, FEE_BUMP_THRESHOLD_XLM, and COINGECKO_API_KEY (Ethereal-Future#348) - Add npm audit --audit-level=high step to CI test workflow, failing the build on high/critical vulnerabilities (Ethereal-Future#349) - Add docker-compose.yml for local development with PostgreSQL, hot-reload backend, and Vite HMR frontend; add Dockerfile.dev for both services (Ethereal-Future#357)
|
@El-Chapo-Npm Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
Developer Experience & CI Improvements
Closes #347
closes #348
closes #349
closes #357
Summary
This PR improves the onboarding experience for new contributors and tightens the CI pipeline. A new contributor can now clone the repo, run
docker compose up, and have a fully working local environment without any manual configuration guesswork.Changes
#347 — CONTRIBUTING.md
Added a full contributing guide covering:
#348 — backend/.env.example
Rewrote the env file with inline documentation for every variable:
[REQUIRED]or[OPTIONAL]PLATFORM_FEE_ACCOUNT_SECRET,FEE_BUMP_THRESHOLD_XLM, andCOINGECKO_API_KEY#349 — CI vulnerability audit
Added
npm audit --audit-level=highto.github/workflows/test.ymlimmediately afternpm install. The build fails if any high or critical vulnerability is found in the dependency tree.#357 — docker-compose.yml for local development
Added a standard
docker-compose.ymlthat spins up three services:db— PostgreSQL 16 with a persistent named volumebackend— Node 20 withnode --watchhot-reload; runsprisma migrate deployon startupfrontend— Vite dev server with HMR, proxying/apito the backendAlso added minimal
Dockerfile.devfor both backend and frontend.Testing
test.ymlaudit step is correctly positioned and uses the right flagCONTRIBUTING.mdsetup steps validated against the actual project scripts and.env.examplevaluesNotes
STREAM_SECRET_ENCRYPTION_KEYindocker-compose.ymlis set to a zeroed placeholder — intentional for local dev only, clearly commentedJWT_SECRETin compose is also a dev-only placeholder with a comment to change it before any real use