Skip to content

Commit 3077cf7

Browse files
committed
add basic CONTRIBUTING document
1 parent 35acd3f commit 3077cf7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contribution guidelines
2+
3+
- Read the [gbdev wide](https://github.com/gbdev/meta/blob/master/CONTRIBUTING.md) contribution guidelines
4+
- Run an English spell checker
5+
- Try to split the PR in small, self-contained parts so they can be reviewed and merged faster (and independently)
6+
- Make sure the code you are adding/changing follows the [GB ASM Style guide](https://gbdev.io/guides/asmstyle.html)
7+
- When adding new content, give first a read to the existing chapters to get an idea of the style and teaching strategies of the document
8+
- gb-asm-tutorial is powered by the same preprocessors and renderers we developed for Pan Docs. This gives you additional features over plain Markdown, most notably the "custom containers". To see how to use them, read the ["Special markup" paragraph](https://github.com/gbdev/pandocs/blob/master/CONTRIBUTING.md#special-markup) of the Pan Docs' CONTRIBUTING.md

0 commit comments

Comments
 (0)