Skip to content

Clarify the contributing guidelines for the main list versus MORE.md #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rangi42 wants to merge 2 commits into
base: master
Choose a base branch
from
+7 −5
Open

Clarify the contributing guidelines for the main list versus MORE.md #263

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eab1af
Clarify the contributing guidelines for the main list versus MORE.md
Rangi42 Jun 9, 2026
0bcd3b3
Remove mention of "history"
Rangi42 Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Search previous suggestions and open issues before making a new one, as yours ma

Here's how you can contribute:

- Look at open [Issues](https://github.com/avivace/awesome-gbdev/issues) and provide help or feedback
- Look at open [Issues](https://github.com/avivace/awesome-gbdev/issues) and provide help or feedback
- [Add a resource](#adding-a-resource)
- [Correct and improve existing entries](#correcting-and-improving-resources)
- [Fix broken links and unavailable resources](#removing-unavailable-resources)
Expand All @@ -20,14 +20,16 @@ If you are unsure about something or need help, we have a friendly Discord [chat

For a resource to be added to the list, it must...

- Be in english;
- Be in English;
- Be in a minimal working state;
- Have a clear purpose (implementation reference is okay, too) and/or provide something interesting;
- Provide a minimal documentation briefly describing what is the project and how to make use of it.
- Provide a minimal documentation briefly describing what is the project and how to make use of it;
- Have reached a state where you would personally recommend it to the Game Boy community in general;
- Be *awesome*.

These criteria are discussed [here](https://github.com/gbdev/awesome-gbdev/issues/96).
That last criterion is the most subjective one, but it's what distinguishes this list from being a raw collection of everything related to Game Boy development in general. Don't take the name too seriously -- not being on the list doesn't mean your project *isn't* awesome, and vice-versa, but we would rather leave things out than include too much.

If the resource is in another language, still work in progress, abandoned or you don't think reaches the described standard BUT it's still related to Game Boy development/hacking you can add it to the **MORE.md** file.
For resources which don't *quite* make it to the main list, we have [**MORE.md**](MORE.md). If the resource is in a non-English language, still a work in progress, abandoned, or doesn't reach the described standard *but* is still related to Game Boy development/hacking, then you can add it to the **MORE.md** file.

### Pull Request

Expand Down
Loading