Page MenuHomePhorge
Files F4498804

CONTRIBUTING.md
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

CONTRIBUTING.md
View Options

# Contributing to Ant
Thank you for your interest in contributing to Ant! This document provides guidelines for contributing.
## Getting Started
For the full list of prerequisites and platform-specific setup instructions, <br>
see [BUILDING.md](BUILDING.md#prerequisites).
### Building from Source
```bash
git clone https://github.com/theMackabu/ant.git && cd ant
meson subprojects download
meson setup build
meson compile -C build
```
For detailed build instructions including debug builds, ASan builds, <br>
ccache setup, and Windows/Linux/macOS specifics, see [BUILDING.md](BUILDING.md).
## How to Contribute
### Reporting Bugs
1. Check existing issues first
2. Include reproduction steps
3. Provide system info (OS, compiler version)
4. Include relevant error messages
### Suggesting Features
1. Open an issue with the `enhancement` label
2. Describe the use case
3. Provide examples if possible
### Pull Requests
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/my-feature`)
3. Make your changes
4. Ensure tests pass
5. Submit a pull request
## Code Style
- **C code**: GNU23 standard, 2-space indent, no trailing whitespace
- **Naming**: `snake_case` for functions, `UPPERCASE` for macros
- **Headers**: Local includes (`"..."`) before system includes (`<...>`)
- **Comments**: Avoid unless code is complex
## Project Structure
```
src/
├── cli/ # Command line interface helpers
├── core/ # Bundled snapshot code
├── esm/ # ES module system (loader, resolver, cache)
├── highlight/ # Syntax highlighting (emit, iterators)
├── modules/ # Built-in JS modules (fs, path, shell, etc.)
├── pkg/ # Zig-based package manager
├── silver/ # Silver bytecode compiler and VM
│ └── ops/ # Bytecode operation definitions
├── strip/ # Rust-based type stripping (oxc)
├── tools/ # Code generation scripts (snapshot gen)
├── types/ # TypeScript type declarations
include/ # C header files
tests/ # JavaScript test files
vendor/ # External dependencies
```
For more information about Ant's internal structure, read the [Ant DeepWiki](https://deepwiki.com/theMackabu/ant).
## Testing
- Add tests for new features in `tests/`
- Run specific tests: `./build/ant tests/test_<name>.js`
- Run `./build/ant examples/spec/run.js` to ensure nothing else broke

File Metadata

Mime Type
text/plain
Expires
Sun, May 3, 7:48 AM (1 d, 6 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
520463
Default Alt Text
CONTRIBUTING.md (2 KB)

Event Timeline