2016-06-16 20:48:05 +12:00
|
|
|
# How to contribute
|
|
|
|
|
2020-05-23 16:20:51 +12:00
|
|
|
This document describes some points about the contribution process for Tahoma.
|
2016-06-16 20:48:05 +12:00
|
|
|
|
|
|
|
## Pull-requests
|
|
|
|
|
2020-05-23 16:20:51 +12:00
|
|
|
I love any kind of contributions, such as fixing typos and code refactoring.
|
|
|
|
If you fixed or added something useful to Tahoma, please send pull-requests to me.
|
|
|
|
I will first review the request, then I'll accept it, add comments for rework, or decline it.
|
2016-06-16 20:48:05 +12:00
|
|
|
|
|
|
|
### Workflow
|
|
|
|
|
2020-05-23 16:20:51 +12:00
|
|
|
0. `fork` Tahoma to your GitHub account from `turtletooth/tahoma`.
|
|
|
|
- (use the `fork` button at the https://github.com/turtletooth/tahoma)
|
2016-06-16 20:48:05 +12:00
|
|
|
0. `clone` the repository.
|
2020-05-23 16:20:51 +12:00
|
|
|
- `git clone git@github.com:your-github-account/tahoma.git`
|
|
|
|
- `git remote add upstream https://github.com/turtletooth/tahoma.git`, additionally.
|
2016-06-16 20:48:05 +12:00
|
|
|
0. modify the codes.
|
|
|
|
- `git checkout -b your-branch-name`
|
|
|
|
- `your-branch-name` is a name of your modifications, for example,
|
|
|
|
`fix/fatal-bugs`, `feature/new-useful-gui` and so on.
|
|
|
|
- fix codes, then test them.
|
|
|
|
- `git commit` them with good commit messages.
|
|
|
|
0. `pull` the latest changes form the `master` branch of the upstream.
|
|
|
|
- `git pull upstream master` or `git pull --rebase upstream master`.
|
|
|
|
- apply [clang-format](http://clang.llvm.org/docs/ClangFormat.html) with `toonz/sources/.clang-format`.
|
|
|
|
- `cd toonz/sources`
|
|
|
|
- `./beautification.sh` or `beautification.bat`.
|
|
|
|
- `git commit` them.
|
|
|
|
- `git push origin your-branch-name`.
|
|
|
|
0. make a pull request.
|
|
|
|
|
|
|
|
## Bugs
|
|
|
|
|
2020-05-23 16:20:51 +12:00
|
|
|
If you find bugs, please report details about them using [issues](https://github.com/turtletooth/tahoma/issues).
|
2017-08-24 21:13:52 +12:00
|
|
|
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.
|
2016-06-16 20:48:05 +12:00
|
|
|
Then we will try to reproduce the bugs and fix them.
|
2017-08-24 21:13:52 +12:00
|
|
|
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.
|
2016-06-16 20:48:05 +12:00
|
|
|
|
|
|
|
## Features
|
|
|
|
|
2017-08-24 21:13:52 +12:00
|
|
|
If you had an idea about a new feature, please implement it and send a pull request to us.
|
2020-05-23 16:20:51 +12:00
|
|
|
If you cannot implement the feature, please make a request here.
|
|
|
|
|
2016-06-17 21:29:38 +12:00
|
|
|
|
|
|
|
## Translations
|
|
|
|
|
|
|
|
Translation source (`.ts`) files for OpenToonz GUI are located in `toonz/sources/translations`.
|
2017-08-24 21:13:52 +12:00
|
|
|
If you create new `.ts` files for your language or update an existing one,
|
2016-08-26 07:43:17 +12:00
|
|
|
please send us those modifications as pull-requests.
|
|
|
|
[Qt Linguist](http://doc.qt.io/qt-5.6/linguist-translators.html) is useful for translating them.
|
2016-06-17 21:29:38 +12:00
|
|
|
|
|
|
|
Please send us Qt message (`.qm`) files with `.ts` files if you can make the following modifications.
|
|
|
|
|
2020-05-23 16:20:51 +12:00
|
|
|
Tahoma uses `.qm` files generated from `.ts` files.
|
2016-06-17 21:29:38 +12:00
|
|
|
You can generate `.qm` files by using [Qt Linguist](http://doc.qt.io/qt-5.6/linguist-translators.html).
|
|
|
|
Please locate generated `.qm` files in `stuff/config/loc`.
|