Skip to content

Contributing to Wyn

Thanks for helping out. Here's how to get involved.

Report a Bug

Open a GitHub Issue with:

  • Wyn version (wyn version)
  • OS and architecture
  • Minimal code that reproduces the bug
  • Expected vs actual behavior
  • Error output (full, not truncated)

Suggest a Feature

Open a GitHub Issue. Explain the problem you're solving, not just the solution you want. Include a short code example of how it would look.

Submit a Pull Request

  1. Fork the repo and clone it
  2. Create a branch: git checkout -b fix/short-description
  3. Make your changes
  4. Run tests: make && ./wyn test tests/expect
  5. Run the formatter: wyn fmt on any .wyn files
  6. Push and open a PR against main

Keep PRs small and focused. One fix or feature per PR.

Code Style

  • Run wyn fmt before committing
  • 4-space indentation (no tabs)
  • Keep functions short
  • Name things clearly — no abbreviations unless they're obvious (fn, var, req, res)

Content Style

When writing docs, error messages, or comments:

  • Be specific. Use numbers, not "very fast" or "lightweight."
  • Keep sentences short and punchy.
  • No filler words. Say what you mean.
  • Banned words: tapestry, landscape, captivating, realm, delve, testament, paradigm, holistic, robust, synergy, game-changer, revolutionize, streamline, harness, embark, unleash, dive into, journey through, comprehensive guide.

Ask Questions

Good First Issues

Look for issues labeled good first issue. These are scoped, well-described, and a good way to start.

License

By contributing, you agree your work is licensed under MIT, same as the project.

MIT License — v1.11