Skip to content

Contributing

Durva Dongre edited this page Jun 4, 2025 · 1 revision

So You Wanna Contribute, Huh? ๐Ÿคนโ€โ™‚๏ธ

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.

Before You Begin ๐Ÿ™

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".

How to Contribute โš™๏ธ

  1. Fork this chaos.
  2. Clone your fork like a true hacker in a 90s movie.
  3. Create a new branch (please don't call it fix-stuff or patch-1, have some flair).
  4. Write code. Break stuff. Fix it. Repeat until enlightened.
  5. Commit with a message that tells us something (no "Update README" ten times, we beg you).
  6. PR like a Rockstar. Open a Pull Request. Add a description that's more helpful than โ€œfixed stuffโ€.

๐Ÿง˜ Code Guidelines (We Pretend to Have Standards)

  • 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.

Bugs? Features? Or Existential Crises? ๐Ÿ›

  • 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.

Tests? Maybe. Probably. Kinda. ๐Ÿงช

If your contribution doesnโ€™t break everything โ€” amazing. If it has tests โ€” we will literally throw a virtual party in your honor.

Feedback: The Gift That Keeps on Giving ๐Ÿ’Œ

We may:

  • Approve your PR.
  • Roast your code (lovingly).
  • Ghost you (not ideal, but hey, weโ€™re developers).

Final Words of Non-Wisdom ๐Ÿง˜โ€โ™€๏ธ

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.

๐Ÿ“š Navigation

  • ๐Ÿ“‹ 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

Clone this wiki locally