lists/awesome-gbdev
1
0
Fork 0
mirror of https://github.com/gbdev/awesome-gbdev.git synced 2025-09-01 19:52:38 +02:00
Code Issues Releases Wiki Activity

Improvements and mention reviews

Browse Source
This commit is contained in:
Antonio Vivace
2019-04-27 00:01:09 +02:00
committed by GitHub
parent 01ab9377ab
commit 1c2abf73da
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@@ -18,16 +18,16 @@ If you are unsure about something or need help, we have a friendly Discord [chat
### Is it "awesome"?
For a resource to be added to the list, it must reach a minimum quality standard:
For a resource to be added to the list, it must...
- It must be in english;
- It must be in a minimal working state;
- It must have a clear purpose (implementation reference is okay, too) and/or provide something interesting;
- It must provide a minimal documentation briefly describing what is the project and how to make use of it.
- 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.
These criteria are discussed [here](https://github.com/gbdev/awesome-gbdev/issues/96).
If the resource is 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.
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.
### Pull Request
@@ -43,6 +43,8 @@ If the resource is still work in progress, abandoned or you don't think reaches
If you are not confident in forking the repository, making the change and sending the PR, don't hesitate to open an Issue describing the addition (or the change you want to make/discuss).
Before the PR gets approved and merged, we may require a number of reviews from our contributors.
## Correcting and improving resources
Most of the linked resources are hosted on Git repositories. You are encouraged to report errors in the corresponding upstream repository or contact the authors. If the correction doesn't get merged, fork it and mantain an updated/correct version and open a PR replacing the link on the list with your version.