lists/awesome-gbdev
1
0
Fork 0
mirror of https://github.com/gbdev/awesome-gbdev.git synced 2025-08-17 21:32:14 +02:00
Code Issues Releases Wiki Activity

Restructure contribution guide. Fix #118

Browse Source
This commit is contained in:
Antonio Vivace
2018-10-01 08:57:08 +02:00
parent e08b15b141
commit 922e38b71d
1 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

@@ -4,8 +4,14 @@ Before sending a Pull Request or opening an Issue, ensure it adheres to the foll
Search previous suggestions and open issues before making a new one, as yours may be a duplicate.
The simplest way to contribute to this project is to look at [Issues](https://github.com/avivace/awesome-gbdev/issues) or open [Pull Requests](https://github.com/avivace/awesome-gbdev/pulls), your help and feedback is precious.
Here's how you can contribute:
- Look at [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)
If you are unsure about something or need help, we have a friendly Discord [chat](https://discord.gg/gpBxq85).
## Adding a resource
@@ -13,18 +19,12 @@ The simplest way to contribute to this project is to look at [Issues](https://gi
For a resource to be added to the list, it must reach a minimum quality standard:
- It must be in a minimal working state (and documented on how to make it work);
- 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/README briefly describing what is the project and how to make use of it.
- It must provide a minimal documentation briefly describing what is the project and how to make use of it.
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 add it to the MORE.md file.
### Issue
If you are not confident in forking the repository, making the changes and sending a Pull Request, you can have a resource added to the list simply opening an Issue reporting the resource(s) you think could be a nice addition. Be sure to tag the Issue with the `addition` label. Someone will look at it and make a PR for you.
Obviously, you can use Issues to discuss anything about the list.
### Pull Request
- Make an individual pull request for each suggestion.
@@ -35,9 +35,10 @@ Obviously, you can use Issues to discuss anything about the list.
- Start the description with a capital and end with a full stop/period.
- Check your spelling and grammar.
- It's `Game Boy`, not `gameboy`, `game boy` or `GameBoy`, however, you should honor the title or name of the resource while linking it, even if it's using a wrong lettering \[[1](https://github.com/avivace/awesome-gbdev/issues/34)\].
- Games and Homebrews go to the GAMES.md file.
- Open source emulators go to the EMULATORS.md file.
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).
## Correcting and improving resources
Most of the linked resources are hosted on Git repository. You are encouraged to report errors in the corrisponding 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.
@@ -47,8 +48,6 @@ In any case, open an Issue mentioning the error and its magnitude. This can have
- If the resource is unique/important - while we wait for the error getting corrected in the upstream source - we add an Errata notice next near the link. OR
- The resource gets moved in MORE, until it reaches a decent/maintanable/correct state.
## Not awesome
If you think something doesn't fit the list, open an Issue or a PR mentioning the reasons.
## Removing unavailable resources
@@ -59,7 +58,7 @@ You're welcome to remove any broken link in the repository, but first try to fin
- We may already mirrored it in [*The Game Boy Archive*](https://github.com/gb-archive/core) project;
- Try the GitHub search.
Then, **open an Issue** with the label `missing` with the resource link, description and any other useful details.
Then, **open an Issue** with any useful details.
You can then proceed to remove the broken link (or wait for someone to do it).