Skip to content

infra(contributors): sync contributor tables across all package READMEs (#1076) #1429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ZacLou wants to merge 1 commit into from
Closed

infra(contributors): sync contributor tables across all package READMEs (#1076) #1429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .all-contributorsrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 @<username> for <contribution-type>
```

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
Expand Down
11 changes: 11 additions & 0 deletions backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
11 changes: 11 additions & 0 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
11 changes: 11 additions & 0 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
13 changes: 12 additions & 1 deletion packages/flowfi-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/
[openapi-generator]: https://openapi-generator.tech/

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Loading