Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 1.79 KB
Raw

Contributing to Aleph.js

Welcome, and thank you for taking time in contributing to Aleph.js! You can improve Aleph.js in different ways:

  • ∆ add new features
  • ✘ bugfix
  • ✔︎ review code
  • ☇ write plugins
  • 𝔸 improve our documentation

Development Setup

You will need Deno 1.8+.

  1. Fork this repository to your own GitHub account.
  2. Clone the repository to your local device.
  3. Create a new branch git checkout -b BRANCH_NAME.
  4. Change code then run the examples.
  5. Push your branch to Github after all tests passed.
  6. Make a pull request.
  7. Merge to master branch by our maintainers.
# ssr/development with HMR
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts dev ./examples/hello-world -L debug

# ssr/production
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts start ./examples/hello-world -L debug

# ssg
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts build ./examples/hello-world -L debug

# run all tests
deno test -A --unstable --location=http://localhost --import-map=./import_map.json

Project Structure

  • /bundler bundler for production mode
  • /commands commands code
  • /compiler the compiler written in rust powered by swc
  • /framework
    • core framework core
    • react framework in React
  • /design design drawings and assets
  • /examples examples
  • /plugins official plugins
  • /server server code
  • /shared shared code

Code Style We Followed

  • Single quote for string
  • No semicolon
  • 2 spaces indent
  • Types everything
  • Order your imports

Code of Conduct

All contributors are expected to follow our Code of Conduct.