From de53c7784fcec3c77da71bebaa22500cf00feb06 Mon Sep 17 00:00:00 2001 From: ZacLou Date: Wed, 2 Sep 2026 08:36:14 +0800 Subject: [PATCH] infra(contributors): sync contributor tables across all package READMEs (#1076) Closes #1076 - Adds all-contributors sections to backend/README.md, contracts/README.md, frontend/README.md, and packages/flowfi-sdk/README.md. - Updates .all-contributorsrc files array so the bot keeps every listed README in sync. - Documents the @all-contributors trigger command and contribution types in CONTRIBUTING.md. --- .all-contributorsrc | 6 +++++- CONTRIBUTING.md | 16 ++++++++++++++++ backend/README.md | 11 +++++++++++ contracts/README.md | 11 +++++++++++ frontend/README.md | 11 +++++++++++ packages/flowfi-sdk/README.md | 13 ++++++++++++- 6 files changed, 66 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index e13703fb..e96acc23 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,6 +1,10 @@ { "files": [ - "README.md" + "README.md", + "backend/README.md", + "contracts/README.md", + "frontend/README.md", + "packages/flowfi-sdk/README.md" ], "imageSize": 100, "contributorsPerLine": 7, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd869c90..f907d1c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -474,6 +474,22 @@ Be constructive. # Final Notes +--- + +# 🏅 Recognizing Contributors + +FlowFi uses the [all-contributors](https://github.com/all-contributors/all-contributors) specification to recognize every kind of contribution. The bot synchronizes the contributor table across the root README and the READMEs for `backend/`, `contracts/`, `frontend/`, and `packages/flowfi-sdk/`. + +To add or update a contributor, comment on any issue or PR with: + +```text +@all-contributors please add @ for +``` + +Common contribution types include `code`, `doc`, `test`, `bug`, `ideas`, and `review`. See the [all-contributors emoji key](https://allcontributors.org/docs/en/emoji-key) for the full list. + +The bot will open a PR that updates every README listed in `.all-contributorsrc`. Maintainers can merge that PR once CI passes. + - Contributions of all sizes are welcome - Documentation improvements are valuable - Ask questions in Issues if unsure diff --git a/backend/README.md b/backend/README.md index fe646d13..ab0cbfca 100644 --- a/backend/README.md +++ b/backend/README.md @@ -91,3 +91,14 @@ Structured JSON logs generated by Winston (`backend/src/logger.ts`) attach a `re - **HTTP Requests:** Set via `requestIdMiddleware` (`X-Request-ID` header or auto-generated UUID). - **Worker Poll Batches:** Each poll cycle in `SorobanEventWorker` runs in `requestContext.run({ requestId: randomUUID() }, ...)` so all event logs and error traces share a single ID per cycle. - **Admin Replays:** Replays triggered via `replayFromLedger` / `POST /v1/admin/indexer/replay` execute under a shared `requestId` that is included in all indexer log statements and returned in the HTTP 202 JSON response. + +## Contributors + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/contracts/README.md b/contracts/README.md index 6a7e0a58..018a9aa9 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -102,3 +102,14 @@ stellar contract optimize --wasm target/wasm32-unknown-unknown/release/stream_co ``` The optimized WASM file will be available at `target/wasm32-unknown-unknown/release/stream_contract.optimized.wasm`. + +## Contributors + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/frontend/README.md b/frontend/README.md index 2759728a..19cf5e7a 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -29,3 +29,14 @@ NEXT_PUBLIC_RPC_URL=https://soroban-testnet.stellar.org - `npm run build`: Builds the app for production. - `npm start`: Runs the production server. - `npm run lint`: Runs ESLint to check for code issues. + +## Contributors + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/packages/flowfi-sdk/README.md b/packages/flowfi-sdk/README.md index 914c1cf7..ccd2bdf6 100644 --- a/packages/flowfi-sdk/README.md +++ b/packages/flowfi-sdk/README.md @@ -34,4 +34,15 @@ const api = new StreamsApi(new Configuration({ basePath: 'https://api.flowfi.io/ const { data } = await api.getStream(1); ``` -[openapi-generator]: https://openapi-generator.tech/ \ No newline at end of file +[openapi-generator]: https://openapi-generator.tech/ + +## Contributors + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!