WebAssembly / WebAssembly/wasi-libc

Style guide

Open
#116 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
1k
Forks
251
Avg merge
7h 15m
Merged PRs (30d)
3

Description

It would good to have a explicit style guide for contributors of this repo (and maybe others in Cranelift). Because there are some divergences between different files (like comment style here and here) and sometimes it hard to make code follow the style guide.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the comment styles in libc-bottom-half/crt/crt1.c around line 108 and libc-bottom-half/mman/mman.c around line 61. Review the surrounding contributor conventions and identify the scope of a guide for this repository. Done means contributors have an explicit style guide that addresses the documented divergences.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, wasm
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.