Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Editor configuration

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with the recommendations in list/guides/asmstyle.md and inspect the existing site structure to find where editor-configuration guidance could fit. Define the supported editors and GtkSourceView coverage before writing instructions; the work is done when the site explains how to distinguish SM83 assembly from other assembly syntaxes.

Written by the indexing model from the issue text.

Description

From https://gbdev.io/guides/asmstyle.html#recommendations (source code is https://github.com/gbdev/gbdev.github.io/blob/dev/list/guides/asmstyle.md)

Please use the .asm (or .s) file extensions, not .z80. The GB CPU isn't a Z80, so syntax highlighters get it mostly right, but not quite. And it helps spreading the false idea that the GB CPU is a Z80. 😢

Syntax highlighters get it even less right when .s and .asm default to x86 syntax on x86 PCs or to ARM syntax on ARM PCs. Would it be appropriate for some page on this site to give instructions to configure popular text editors (and frameworks used by multiple editors, such as GtkSourceView) to distinguish files in assembly language for SM83 instruction set from files in assembly language for other instruction sets?

Dominant language
Assembly
Stars
34
Forks
16
PR merge metrics
No merged PRs in 30d

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.

More from gbdev/gbdev.github.io

All issues in gbdev/gbdev.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.