Skip to content

fix: docs: add CONTRIBUTING.md #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VedantMadane wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: docs: add CONTRIBUTING.md #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

Thanks for contributing to this project.

## Setup

1. Fork and clone this repository.
2. Install dependencies from the project toolchain files.
3. Run the test suite (or build) before opening a pull request.

## Pull requests

- Keep changes focused and clearly described.
- Link related issues (for example `Fixes #123`).
- Include a short test plan.
- Match existing code style.

## Conduct

Be respectful and constructive in reviews and discussions.
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,7 @@ $ pnpm test:sandbox
```

The test corpus runs each program under Node and as a compiled native binary, then compares stdout, stderr, and exit codes byte for byte. The full gate also runs the corpus with AddressSanitizer and the runtime reference-count audit.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).