-
Notifications
You must be signed in to change notification settings - Fork 2
Contributing
Durva Dongre edited this page Jun 4, 2025
·
1 revision
First of all, welcome, brave soul. If you're reading this, either:
- You've found a bug (congrats, the prophecy foretold this),
- You're bored at work and this repo seemed quirky,
- Or you just love pain โ which makes you one of us.
Please ensure:
- You're using your brain and not just autopilot copypasta mode.
- You've read the code (or at least pretended to โ we respect commitment to the bit).
- You're not about to rewrite everything in [insert trendy language here] because "it's cleaner, bro".
- Fork this chaos.
- Clone your fork like a true hacker in a 90s movie.
- Create a new branch (please don't call it
fix-stufforpatch-1, have some flair). - Write code. Break stuff. Fix it. Repeat until enlightened.
- Commit with a message that tells us something (no "Update README" ten times, we beg you).
- PR like a Rockstar. Open a Pull Request. Add a description that's more helpful than โfixed stuffโ.
- Follow the existing code style โ we use ESLint and Prettier to keep the entropy symmetrical.
- Write meaningful commit messages. Not poetic, not cryptic, just... coherent.
- If youโre introducing bugs cleverly disguised as features, at least add a test. Predictable failure is still a kind of success, philosophically speaking.
- Found a bug? Open an issue.
- Got a feature idea? Open an issue.
- Spiraling after realizing your entire app is just an API wrapper? Go outside, touch grass, then open an issue.
If your contribution doesnโt break everything โ amazing. If it has tests โ we will literally throw a virtual party in your honor.
We may:
- Approve your PR.
- Roast your code (lovingly).
- Ghost you (not ideal, but hey, weโre developers).
This repo is a digital organism โ sometimes alive, sometimes undead. By contributing, you agree to:
- Embrace the absurdity,
- Accept constructive chaos,
- And debug like the universe is watching (because it is).
Thanks for contributing! Or at least reading this far โ thatโs contribution enough in spirit.
- ๐ Research
What we're actually going to build vs what we dream about - ๐บ๏ธ Roadmap
Our master plan (subject to reality checks) - ๐งฉ Components
The building blocks that hopefully work together - ๐ก API Guide
Interfaces to every modular service, from market data to tax - ๐ฐ Funding
How we keep the lights on (and the servers running) - ๐๏ธ Architecture
The technical deep dive for masochists - โ
Todo List
Whatโs pending, whatโs burning, and whoโs guilty - ๐ค Contributing
Join the chaos, we have cookies*
*Cookies not guaranteed