OpenToonz - An open-source full-featured 2D animation creation software
How to contribute
This document describes some points about the contribution process for OpenToonz.
Pull-requests
The OpenToonz organization loves any kind of contributions, such as fixing typos and code refactoring. If you fixed or added something useful to OpenToonz, please send pull-requests to us. We will first review the request, then we will accept it, add comments for rework, or decline it.
Workflow
forkOpenToonz to your GitHub account fromopentoonz/opentoonz.
- (use the
forkbutton at the https://github.com/opentoonz/opentoonz)
clonethe repository.
git clone [email protected]:your-github-account/opentoonz.gitgit remote add upstream https://github.com/opentoonz/opentoonz.git, additionally.
- modify the codes.
git checkout -b your-branch-nameyour-branch-nameis a name of your modifications, for example,fix/fatal-bugs,feature/new-useful-guiand so on.
- fix codes, then test them.
git committhem with good commit messages.
pullthe latest changes form themasterbranch of the upstream.
git pull upstream masterorgit pull --rebase upstream master.- apply clang-format with
toonz/sources/.clang-format.cd toonz/sources./beautification.shorbeautification.bat.
git committhem.git push origin your-branch-name.
- make a pull request.
Bugs
If you find bugs, please report details about them using issues.
Please include information needed to reproduce the bug, including the operating system
and information directly relating to the issue. Links to screen captures of what is
observed on screen or video of specific steps to produce the problem are very helpful.
Then we will try to reproduce the bugs and fix them.
Unfortunately, bugs can sometimes only be reproduced in your own environment,
so we cannot reproduce them.
If you believe you can fix the bug, please submit a pull request.
Features
If you had an idea about a new feature, please implement it and send a pull request to us. If you cannot implement the feature, please open a topic on the Google Group Page. It enables us to discuss implementations of the feature there. Feature requests posted on GitHub without an active developer or funding will be closed to keep the issue tracker from becoming cluttered with unfulfilled feature requests.
Translations
Translation sources (.ts) are in toonz/sources/translations. Contributors can
edit them with Qt Linguist and submit a PR, or attach the updated files to an
issue/discussion for a maintainer to integrate. A full application build is not
required to contribute wording. Share editable sources; compiled .qm files are
optional test artifacts unless a maintainer requests them.
See Contributing and maintaining translations for the two workflows: sharing translations, and reviewing/merging/updating them. The guide includes existing Qt Linguist, shell-script, and CMake/Visual Studio processes, validation, runtime paths, and packaging checks.