Skip to main content

Development Guidelines

Welcome to the Vyndara development rules! These are here to keep our code clean, maintainable, and make sure we don’t turn this project into an unmanageable mess. Stick to them, and things will run smoothly.

Keep It Clean​

  • Write code like a human, not a machine. Use clear variable names, keep things simple, and don’t overcomplicate stuff.
  • Small functions, big impact. If a function is doing more than one thing, split it up.
  • Readability beats cleverness. If you need a comment to explain your one-liner wizardry, rethink it.

Code Like a Pro​

  • TDD or regret it later. Write tests first, so you don’t cry later.
  • No half-baked commits. Make meaningful commits with proper messages. No ‘fix stuff’ commits.
  • Review, then merge. No code goes in without someone else looking at it.

Handle Errors Properly​

  • Don't just log errors, handle them. Ignoring errors is a crime.
  • Log like you mean it. Clear, structured logs make debugging easier.
  • Security matters. No leaking secrets in logs or error messages.

Work as a Team​

  • Follow the agreed standards. No cowboy coding.
  • Document what needs documenting. Nobody likes hunting for answers in Slack.
  • Keep dependencies fresh. Outdated packages are a ticking time bomb.

Follow these rules, and we’ll all have a better time building Vyndara. If you have a better way to do something, bring it up – but don’t just go rogue.