Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (88 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

136 lines (88 loc) · 2.22 KB

Contributing to Reflex

First of all — thank you for being here.

Reflex is not just code.
It is a living system of ideas, people, responsibility, and respect.

By contributing, you agree to follow our Code of Conduct.

What We Care About Most

  1. People > Code
  2. Clarity > Cleverness
  3. Useful > Fancy
  4. Tested > Believed
  5. Documented > Assumed

Ways To Contribute

You can contribute by:

  • Writing code
  • Improving documentation
  • Adding tests or benchmarks
  • Reporting issues (clearly and respectfully)
  • Reviewing PRs
  • Proposing ideas (with reasoning)

Quality > Quantity

Before Opening a PR

Ask yourself:

  1. Is this needed?
  2. Is it clear?
  3. Is it tested?
  4. Is it documented (even briefly)?
  5. Would I feel safe receiving this PR?

If any answer is “no” — improve before submitting.

How to Communicate

We prefer:

  • Clear, respectful language
  • Structured thoughts
  • Examples over abstraction
  • Humility over ego
  • Questions over assumptions

Avoid:

  • “This is stupid”
  • “You should know this”
  • “Obviously…”
  • Aggressive tone

Instead use:

  • “I believe…”
  • “Maybe we could…”
  • “What if…”
  • “Let’s check…”

Commit Style (Simple)

Use plain, descriptive messages:

  • fix: prevent double scheduling in scheduler
  • docs: clarify ownership model
  • perf: reduce allocations in signal graph
  • test: add cases for async ordering

No poetry. No drama. Just facts.

Code Style Principles

We care about:

  • Readability
  • Predictability
  • Minimal magic
  • Clear names
  • Stable behavior
  • Measurable performance

If something is clever but unreadable — we do not accept it.

Design Contributions

If you propose architectural or theoretical changes:

Include:

  1. Problem statement
  2. Proposed solution
  3. Trade-offs
  4. Alternatives considered
  5. Example use-case

This is required. No exceptions.

Important: You Are Not Alone

If you feel unsure about anything:

Open a discussion.
Ask a question.
Request clarification.

There is no shame in asking.

There is only shame in ego.

A Reflex contributor is not someone who writes code.
A Reflex contributor is someone who makes the space stronger.