Difference between revisions of "Contribute"

From MSX Game Library

Line 15: Line 15:
 
** The [https://aoineko.org/msxgl-doc source code documentation].
 
** The [https://aoineko.org/msxgl-doc source code documentation].
  
* '''Help to better document sample programs''', in particular through source code comments. To do this, you can use Push requests (PR) via the [https://github.com/aoineko-fr/MSXgl project's GitHub].
+
* '''Improve sample programs documentation''', in particular through source code comments. To do this, you can use Push requests (PR) via the [https://github.com/aoineko-fr/MSXgl project's GitHub].
  
 
* '''Use #MSXgl hash tag''' on social media to help people found resources about the library.
 
* '''Use #MSXgl hash tag''' on social media to help people found resources about the library.
  
 
=== Code ===
 
=== Code ===

Revision as of 19:43, 3 February 2025

This page lists the ways you can contribute to improving MSXgl.

If you're interested, the most convenient way to start is by joining the project's Discord Logo.png Discord server.

How can I contribute?

Knowledge base

  • Create MSXgl based programs and share the source code. If you can film the creation and share the video, that's even better. 😎
    • This is useful for game creators, as they can see how others solve challenges they may also face, and it can serve as a tutorial for people discovering the MSXgl library and tools chain.
    • It's also very helpful for MSXgl creator, as it provides programs that can serve as test cases when there are impactful changes to the library or build tool.
  • Review the documentation and report errors, omissions, or unclear parts. If you can provide improved version, it's even better. 🖤
  • Improve sample programs documentation, in particular through source code comments. To do this, you can use Push requests (PR) via the project's GitHub.
  • Use #MSXgl hash tag on social media to help people found resources about the library.

Code