Contributing
ReeWeb is open source under the MIT License. You may use, modify, redistribute, and build commercial software with it under those terms.
The project remains maintainer-led. Changes are accepted when they fit the architecture, product direction, and long-term maintenance standard. A public repository is not a promise to merge every feature.
Before opening an issue
A useful report includes:
- A concrete problem you encountered in real use.
- The smallest template or project that reproduces it.
- Your ReeWeb version and the output of
bun --version. - What you already tried.
- The result you expected and the result you received.
Open an issue on GitHub after searching for an existing report.
Before opening a pull request
Small fixes with focused tests are welcome. Discuss substantial features before implementing them so the direction can be evaluated first.
Follow the repository conventions in AGENTS.md. Keep changes focused, preserve the zero-runtime-dependency model, and put project-specific behavior in the documented extension points rather than changing upstream library files casually.
Generating and running locally
Create a project and run it - the install script runs automatically with bun create:
bun create reepolee/reeweb my-site
cd my-site
bun dev
Prefer to work from a source checkout of the repository itself (for example, to open a pull request from your own fork)? Clone it instead and run bun install - the first dependency install fires the same installer:
git clone https://github.com/reepolee/reeweb.git my-site
cd my-site
bun install
bun dev
ReeWeb is in beta. APIs, templates, and project structure may still change before 1.0.
Security issues
Do not report suspected vulnerabilities in a public issue. Email security@reepolee.com with the affected version, a minimal reproduction or proof of concept, and the expected impact.
License
Contributions are made to the project under its MIT License. The Reepolee and ReeWeb names and logos are not automatically licensed as part of software contributions.