Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
149 lines (112 loc) · 5.78 KB

CONTRIBUTING.md

File metadata and controls

149 lines (112 loc) · 5.78 KB
Raw

Contributing to ReactPress

Thank you for your interest in contributing to ReactPress!

Please read this guide before opening a pull request. By participating, you agree to abide by our Code of Conduct.

Ways to Contribute

Type How
Bug reports Bug report — steps, component, versions, logs
Feature ideas Feature request — problem, solution, area
Community tasks Help wanted — claim a scoped item from proposed issues
Product feedback Feedback & suggestions — UX and operator ideas (not security)
Code & docs Fork, branch, submit a PR (see below)
Security issues Follow SECURITY.md — do not use public issues

Security Contributors

We thank researchers who practice responsible disclosure and help keep ReactPress secure. Valid reports are credited in CHANGELOG.md and GitHub Security Advisories when applicable.

Contributor Contribution
lsr365400 Reported SQL injection and stored XSS (GHSA-wmw4-mw6x-6vfm); contributed fixes in PR #83

Development Setup

Prerequisites

  • Node.js >= 18.0.0
  • pnpm >= 8.0.0
  • MySQL 5.7+ (or Docker via pnpm run init / pnpm docker:dev)

First run

git clone https://github.com/fecommunity/reactpress.git
cd reactpress
pnpm install
pnpm run init      # .reactpress/config.json + .env
pnpm run dev       # toolkit → API (3002) → client (3001)

Run pnpm test and pnpm test:smoke before submitting changes that touch the CLI or API.

Project Structure

reactpress/
├── cli/             # @fecommunity/reactpress — init, dev, build, doctor
├── server/          # NestJS API (primary backend)
├── client/          # Next.js admin & public frontend
├── toolkit/         # OpenAPI-generated API SDK + theme utilities
├── themes/          # Classic theme manifests & reference themes
├── templates/       # Starter project templates
├── docs/            # Docusaurus documentation site
├── scripts/         # Dev, deploy, and lifecycle scripts
└── .reactpress/     # Local CLI config (generated)

Development Workflow

Task Command
Full stack dev pnpm dev
API only (watch) pnpm dev:api or pnpm dev:server
Client only pnpm dev:client
Docker MySQL + proxy pnpm docker:dev
Regenerate API types pnpm run build:toolkit
Swagger spec pnpm run generate:swagger
API lifecycle pnpm run start:api / stop / restart / status

pnpm dev builds toolkit first, waits for API health, then starts the client.

After API changes: pnpm run generate:swagger → pnpm run build:toolkit.

Building

pnpm run build              # toolkit + server + client
pnpm run build:server       # Nest only
pnpm run build:client       # Next.js only
pnpm run build:docs         # Docusaurus site

Pull Request Process

  1. Fork the repository and create a feature branch from master.
  2. Make focused changes — one logical change per PR when possible.
  3. Follow conventions (see below).
  4. Test locally — at minimum pnpm test for CLI changes and manual smoke for UI/API.
  5. Update docs if behavior, CLI flags, or configuration change.
  6. Open a PR using the pull request template.

We review PRs as promptly as we can. Larger changes benefit from an issue discussion first.

Coding Conventions

  • Language: TypeScript for application code; match existing patterns in each package.
  • Formatting: Prettier via lint-staged on commit (pnpm precommit).
  • Commit messages: Conventional Commits style:
    • feat: new feature
    • fix: bug fix
    • docs: documentation only
    • refactor: code change without behavior change
    • chore: tooling, deps, CI
  • Scope: Prefer package-scoped changes (cli, server, client, toolkit).

Production & Publishing

pnpm run build
pnpm run pm2                # PM2 for API + client
# or
sh scripts/deploy.sh

Maintainers only:

pnpm login
pnpm run publish:packages

Published packages: root meta, server, client, toolkit, templates. @fecommunity/reactpress is the CLI entry (init, dev, Docker database helpers).

Architecture & Documentation

Topic Reference
Platform overview docs/tutorial/intro.md
ReactPress 3.0 docs/tutorial/tutorial-extras/reactpress-3-0.md
Upgrade from 2.x docs/migration-2-to-3.md
Configuration docs/tutorial/tutorial-extras/config-intro.md
Theme manifest schema themes/theme.manifest.schema.json
Changelog CHANGELOG.md

Live docs: blog.gaoredu.com

Questions?

Thank you for helping make ReactPress better!