diff options
| author |  hiroki osame <hiroki.osame@gmail.com>
| 2023-04-06 07:18:02 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-04-06 04:18:02 -0700 |
| commit | aa4c4a9b225f07aee7d7f66083cde6d7fc520bc5 (patch) | |
| tree | ec869b0761a1cd5c95a4600beede4b663cce2205 | |
| parent | 569d4940bb68cb47fa546b5505f5a326073d6c5c (diff) | |
| download | bun-aa4c4a9b225f07aee7d7f66083cde6d7fc520bc5.tar.gz bun-aa4c4a9b225f07aee7d7f66083cde6d7fc520bc5.tar.zst bun-aa4c4a9b225f07aee7d7f66083cde6d7fc520bc5.zip | |
docs(CONTRIBUTING): referece development guide (#2576)
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 997b7598b..0f894a116 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Bun -All contributions need test coverage. If you are adding a new feature, please add a test. If you are fixing a bug, please add a test that fails before your fix and passes after your fix. +> **Important:** All contributions need test coverage. If you are adding a new feature, please add a test. If you are fixing a bug, please add a test that fails before your fix and passes after your fix. ## Bun's codebase @@ -16,6 +16,10 @@ Today (February 2023), Bun's codebase has five distinct parts: The JavaScript transpiler & module resolver is mostly independent from the runtime. It predates the runtime and is entirely in Zig. The JavaScript parser is mostly in [`src/js_parser.zig`](src/js_parser.zig). The JavaScript AST data structures are mostly in [`src/js_ast.zig`](src/js_ast.zig). The JavaScript lexer is in [`src/js_lexer.zig`](src/js_lexer.zig). A lot of this code started as a port of esbuild's equivalent code from Go to Zig, but has had many small changes since then. +## Getting started + +Please refer to [Bun's Development Guide](https://bun.sh/docs/project/developing) to get your dev environment setup! + ## Memory management in Bun For the Zig code, please: |