Skip to content

Siv3D Contribution Guide

Thank you for considering contributing to Siv3D.
We appreciate your efforts and contributions to improving the project.
This guide explains how to make contributions as smoothly as possible.

Branch Strategy

There are two main branches:

Please fork from the appropriate branch and make your changes there.
Unless instructed otherwise, please submit pull requests to the v6_develop branch.

Creating Pull Requests

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for feature additions or fixes.
  4. Make changes following the coding style.
  5. Commit following the commit guidelines.
  6. Push changes to your fork.
  7. Create a pull request with comments describing your changes.

Commit Guidelines

  • Multiple commits in one pull request are acceptable.
  • Keep commit messages clear and concise.
  • If possible, reference related issue numbers in commit messages.

Discussion and Communication

  • For large changes or new features, please consult with maintainers through the Siv3D Discord server or GitHub Issues before starting work.
  • You can ask questions or request clarification at any stage of the contribution process.

Building the Library

  • For details on how to build the Siv3D library yourself, please refer to the build instructions.

Pull Request Examples

For minor changes or fixes that don't affect functionality, you can also create pull requests directly without creating an issue.

OpenSiv3D Implementation Meetups

If you're unfamiliar with GitHub operations, we provide support through the Siv3D Discord server and OpenSiv3D implementation meetups.