Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

90 lines (63 loc) · 3.5 KB
Raw

Contributing

We are grateful for any contributions from the community. Here are some ways you can help the project:

Reporting Issues

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Bug Reports

Please do NOT submit bug reports about odd behavior caused by using the provided utilities to break the game.

Include the following in your report, with as much detail as possible:

  • Steps to reproduce the issue.
  • Expected behavior and observed behavior.

Feature Requests

Please do NOT submit suggestions that are too subjective to be considered improvements.

Include the following in your request, with as much detail as possible:

  • Detailed description of the proposed changes.
  • How the changes will fit in with the current design.
  • (Optional) Any info relevant to the feature's implementation.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/tpgz.git

Project structure

tpgz
├───.github
│   └───workflows         // github action(s) used to test code compilation
├───external              // external libraries and programs consumed by tpgz
│   ├───fonts             // small rust program to generate raw bytes and c code for utilizing true-type fonts in game
│   │   ├───fonts         // ttf files
│   │   └───src           // source code for fonts
│   ├───gcn_c             // game independent gamecube apis to link to
│   │   ├───include       // header files for gcn_c
│   │   └───src           // source code for gcn_c
│   └───libtp_c           // game bindings for twilight princess
│       ├───.github
│       │   └───workflows // github action(s) used to test code compilation
│       ├───include       // header files for libtp_c
│       └───src           // source code for libtp_c
├───include               // header files for tpgz
│   └───fonts             // individual font properties such as width, height, glyphs, etc.
├───res                   // external resources to be consumed
│   └───save_files        // raw quest log bytes to be injected at compile time
└───src                   // source code for tpgz
    └───fonts             // raw bytes for fonts

Building

See BUILDING.md.

Linting

There is currently no linter for the project, and style is not strictly enforced. To be safe, you should format according to the .clang-format located at the root of the project. Code that does not meet the current quality standard will be rejected.

Sending a Pull Request

For non-trivial changes, you may want to open an issue with a proposal for a new feature before starting on the work. We don't want you to waste your efforts on a pull request that won't be accepted.

In general, the contribution workflow looks like this:

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Submit a pull request, referencing any issues it addresses.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!