Fixed tons of stuff in ./web/documentation/*. No code changes. (0.40.5)
This commit is contained in:
parent
567fa73796
commit
e7e1343a83
134 changed files with 730 additions and 1928 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
published: true
|
||||
noToc: true
|
||||
noToc: false
|
||||
noComments: false
|
||||
noDate: false
|
||||
title: Fun - Contributing to Fun
|
||||
|
|
@ -10,44 +10,43 @@ description: How to contribute, project structure, coding style, running tests,
|
|||
permalink: /documentation/contributing/
|
||||
lang: en
|
||||
tags:
|
||||
- documentation
|
||||
- handbook
|
||||
- installation
|
||||
- usage
|
||||
- introduction
|
||||
- help
|
||||
- guide
|
||||
- howto
|
||||
- docs
|
||||
- specifications
|
||||
- specs
|
||||
- repl
|
||||
- coding
|
||||
- contribute
|
||||
- contributing
|
||||
- guidelines
|
||||
- project
|
||||
- running
|
||||
- structure
|
||||
- style
|
||||
- tests
|
||||
---
|
||||
|
||||
# Contributing to Fun
|
||||
|
||||
Thanks for your interest in contributing! This guide covers the basics to get you productive quickly.
|
||||
|
||||
## Getting started
|
||||
- Clone the repo and build (see [build.md](./build/)).
|
||||
- Run tests locally (see [testing.md](./testing/)).
|
||||
- Explore examples (see [examples.md](./examples/)).
|
||||
- Clone the repo and build (see [build/](../build/)).
|
||||
- Run tests locally (see [testing/](../testing/)).
|
||||
- Explore examples (see [examples/](../examples/)).
|
||||
|
||||
## Project structure
|
||||
- `src/` - C core, VM, and opcode implementations ([src/vm](../src/vm/)).
|
||||
- `src/` - C core, VM, and opcode implementations ([https://git.xw3.org/fun/fun/src/branch/main/src/](https://git.xw3.org/fun/fun/src/branch/main/src/){:class="git"}).
|
||||
- `lib/` - Standard library written in Fun.
|
||||
- `web/` - Website and documentation ([https://git.xw3.org/fun/fun/src/branch/main/web/](https://git.xw3.org/fun/fun/src/branch/main/web/){:class="git"}).
|
||||
- `examples/` - Example programs and showcases.
|
||||
- `documentation/` - Documentation.
|
||||
- `spec/` - Language specification drafts.
|
||||
- `cmake/` - CMake configuration and modules.
|
||||
- `scripts/` - Utility scripts for development.
|
||||
- `make` - Helper script for building (wraps CMake).
|
||||
|
||||
## Code style
|
||||
- C: C99, two-space indent, no tabs. Keep functions short and focused.
|
||||
- Fun: two-space indent, snake_case for functions, PascalCase for classes/constructors.
|
||||
- Prefer clear names over abbreviations. See [style-guide.md](./style-guide/).
|
||||
- Prefer clear names over abbreviations. See [style-guide/](../style-guide/).
|
||||
|
||||
## Development workflow
|
||||
1. Create a small, focused branch.
|
||||
2. Add/adjust tests for behavior changes (see [writing-tests.md](./writing-tests/)).
|
||||
2. Add/adjust tests for behavior changes (see [writing-tests](../writing-tests/)).
|
||||
3. Update docs if user-visible behavior changes.
|
||||
4. Submit a PR with a clear description and rationale.
|
||||
|
||||
|
|
@ -63,4 +62,4 @@ Please include:
|
|||
- `fun --version` output
|
||||
|
||||
## Code of Conduct
|
||||
Be respectful and inclusive. See [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT/) in the repository root.
|
||||
Be respectful and inclusive. See [https://git.xw3.org/fun/fun/src/branch/main/CODE_OF_CONDUCT.md](https://git.xw3.org/fun/fun/src/branch/main/CODE_OF_CONDUCT.md){:class="git"} in the repository root.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue