Skip to content

Home

Jump to bottom
Daniel Cleaton edited this page Feb 5, 2025 · 2 revisions

Welcome to the GM-TestFramework wiki!

This repository was established to showcase the internal test framework to users and to offer a platform for the community to contribute their own unit tests for identifying bugs, as well as to improve the framework itself.


Get Involved!

We welcome and appreciate well-documented contributions to the project, which can be made in two key areas:

  • Framework Modules: You can contribute by improving or adding to the framework modules themselves, making them more powerful, versatile, and user-friendly.
  • Unit Tests: Adding more unit tests to cover different aspects of GameMaker's in-game functionality (GMS2 VM/YYC and GMRT).

Be aware that proposed framework module changes need to be relevant to the GameMaker team and our internal usage of TestFramework otherwise they will simply not be accepted. (You're of course free to modify your own fork however you wish, so you do not need to propose anything you only intend to be for your own use.)


How To Contribute

Please follow the standard Git workflow:

  1. Write up an issue in our repo, using the templates we have provided, so you can document your proposed changes and accordingly everyone else knows what you're changing and therefore your changes can be reviewed properly later on
  2. Fork the repository into your own GitHub space (if you have not already done so)
  3. Back on your issue in our repository, set the branch in the right-hand side to be a new branch back on your own fork
  4. Make your changes on that branch in your own repo - be sure to test your changes thoroughly and provide clear comments in yur code as necessary!
  5. When you are done, update your issue with any final information/known issues/etc.
  6. Submit a pull request and ensure the title says "Fixes #your issue number - Some comment" or that your issue is clearly linked in the right-hand panel of the PR - note that you should not need to add much further documentation into the PR, as you should have already added final info into the original issue!
  7. Your PR will then be reviewed in conjunction with the original issue and approved/rejected accordingly

If in any doubt about the flow above, please refer to https://github.com/YoYoGames/GM-TestFramework/issues/51 for an example of writing a detailed issue and linking it to a new branch, then you can click the link in the issue's side bar to see its accompanying https://github.com/YoYoGames/GM-TestFramework/pull/56 for the PR and review steps which came later on.


Thanks!

Your contributions will help make the framework more robust and valuable for the entire GameMaker community.


Clone this wiki locally