I've been working on this API gateway project called Kairos-rs for a while now, and honestly, I could really use some help. It's gotten to a point where I'm pretty happy with what it does, but there's so much more I want to add and I'm realizing I can't do it all myself.
I built it with Actix-web because, well, it's fast and I know it pretty well. Been using reqwest for the HTTP client stuff and the usual suspects like serde for JSON handling.
What am I looking for???
Help in
Optimization, Reducing latency is key if we want to be relevant.
Security, have a reliable and monitorable solution, things like rate limit, remove possible memory leaks.
Features, I would like to do this features => add llm router, websocket support, jwt support, observability, cache support.
Hi! If you’re genuinely interested in looking for contributors, you should probably give your project’s README file, which seems to be in a somewhat broken state. I’m noticing broken TOC links; also there’s a code style guide section that the code obviously doesn’t even follow[1], there’s a Documentation link to non-existing wiki-page, …
… without spending more time than I have at hand on it, I can only assume that the code could be in state as broken as the README file; and even if I’m wrong, you’ll need to consider that anyone else taking a look could come to the same conclusion as I did.
If besides the README file, parts of the code itself are also AI-generated, I believe contributors & reviewers would appreciate that to be more clearly marked/indicated.
Also, looking for contributors for open-source projects is super hard in general, even for the best and most polished and projects out there, with established usage in production. If you keep this reality in mind, it means that explicitly asking for significant help from others when things are as obviously incomplete as they currently seem to be,[2] may even come across as asking others to do all the work for you.
I can’t seem to find any doc comments as detailed as the requirements set them ↩︎
I agree with you, I just updated the readme and roadmap file, redoing it and restructuring it for a better experience, I added a section where it talks about the use of AI to perform reviews and optimizations
The colorful distractions completely made me miss the point that it’s a binary crate, not a library so missing API docs aren’t that significant of an issue if it’s only the mostly-internal-use API for the application’s binary crate to use. Nonetheless, you could consider following the example of many binary crates to make the crate actually a binary-only one, e.g. ripgrep 14.1.1 - Docs.rs, which doesn’t show any library docs due to not offering any lib.rs in the first place[1] – and when doing so also ensure to define a sensible documentation link to appear on the crates.io page ……
…… or you could follow examples such as bat which does acknowledge that it’s usable as a library, and includes at least some minimal top-level module documentation so that the docs.rs main page is at least not completely free of human-readable text, and eventually you could go as far and comprehensive as e.g. what cargo does.
Doing any update to the crate on crates.io will also have the nice side-benefit of re-rendering the crates.io page itself from the up-to-date README.md file
though instead much of its core functionality, especially the regex engine, is of course available as separate libraries… actually…
I just implemented the documentation for functions as well as classes/structs, as suggested by the official Cargo documentation. You can view it on the official Cargo Docs site => kairos_rs - Rust. I'd appreciate any feedback if you have the time.
What you mention about [quote="steffahn, post:4, topic:133956"] ripgrep 14.1.1 - Docs.rs
[/quote] is interesting. Do you think it would be useful to have a CLI for real-time modifications to route configurations without affecting client execution?
so missing API docs aren’t that significant of an issue if it’s only the mostly-internal-use API for the application’s binary crate to use. Nonetheless, you could consider following the example of many binary crates to make the crate actually a binary-only one, e.g.