gamebub

# Contributing to Game Bub

Game Bub welcomes contributions in the form of bug reports, feature requests, and pull requests.

Note that these contribution guidelines apply only to official project repositories, and not to third-party cores or add-ons.

## Bug Reports and Feature Requests

Please submit bug reports and feature requests in the form of a GitHub issue.

If this is a bug report, clearly state the expected and actual behavior.

If this is a compatibility issue (in-game bug), please also provide a save file (if possible), and pictures/videos to demonstrate the issue. If this is an issue with a GBA game, please also state whether you are using the built-in or official GBA BIOS.

## Pull Requests

### Code Quality

This project is a labor of love, and code quality and readability are valued above adding additional features. When submitting code, please make sure it is readable, well-organized, and tested locally. 

Additionally, please break up your contributions into manageable, organized commits, with useful commit messages. This makes it significantly easier to review your code.

### Commit Messages

The first line of your commit message should start with `fpga: `, `firmware: `, etc. to show the primary high-level area it touches.

Most commits should also include a paragraph after that, *briefly* summarizing the commit. A longer message may be useful if, for example, the commit fixes a subtle bug that requires additional explanation.

### AI/LLM Usage

This project was originally developed without any AI assistance, but we recognize that AI tools may be a useful aid in your development workflow. While we don't feel comfortable strictly disallowing all usages of AI, we do require it to be used in a responsible, respectful way. 

As such, all contributors must adhere to the following:

* You may use LLMs for research, exploring ideas, understanding unfamiliar concepts, or as debugging aids. 
* Do not submit unverified, low-quality, or bulk AI generated code. Every line of submitted code must be reviewed, understood, and tested by you.
* Documentation, including code comments, must be human-authored.
* All pull request summaries, commit messages, issues, and comment threads must be written by a human. You should not force another human to read AI generated output, or simply act as an intermediary between another human and an LLM.
* You are fully responsible for all of your contributions. If your pull request is judged to be low effort or overly reliant on AI, it may be closed without review.

### Licensing

By submitting a pull request or contribution to this project, you agree that your contributions are licensed under the project's current license. Additionally, you grant the project maintainer(s) a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, reproduce, modify, display, sublicense, and distribute your contributions under alternative terms. You affirm that you have the full legal right to grant these terms for all submitted content.