Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

Commit 6577be9

Browse files
committed
Update Contributing.md
1 parent 20a3bbd commit 6577be9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

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

5-
-add new features
6-
-bugfix
5+
-submit new features
6+
-find bugs
77
- ✔︎ review code
88
- ☇ write plugins
99
- 𝔸 improve our [documentation](https://github.com/alephjs/alephjs.org)
1010

1111
## Development Setup
1212

13-
You will need [Deno](https://deno.land/) 1.8+.
13+
You will need [Deno](https://deno.land/) 1.13+.
1414

1515
1. Fork this repository to your own GitHub account.
1616
2. Clone the repository to your local device.
@@ -37,24 +37,25 @@ deno test -A --unstable --location=http://localhost --import-map=./import_map.js
3737
## Project Structure
3838

3939
- **/bundler** bundler for production mode
40-
- **/commands** commands code
41-
- **/compiler** the compiler written in rust powered by swc
40+
- **/commands** commands to start
41+
- **/compiler** a JS/TS/JSX compiler written in rust powered by swc
4242
- **/framework**
4343
- **core** framework core
4444
- **react** framework in React
4545
- **/design** design drawings and assets
46-
- **/examples** examples
46+
- **/examples** examples to learn
4747
- **/plugins** official plugins
48-
- **/server** server code
48+
- **/server** server to run apps
4949
- **/shared** shared code
5050

5151
## Code Style We Followed
5252

5353
- Single quote for string
54-
- No semicolon
54+
- No semicolons
5555
- 2 spaces indent
5656
- Types everything
5757
- Order your imports
58+
- Format code using vscode default TS Server
5859

5960
## Code of Conduct
6061

0 commit comments

Comments
 (0)