diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c67b1ba..1e8e574 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,9 @@ This document describes some points about the contribution process for OpenToonz ## Pull-requests -The OpenToonz organization loves any kind of your contributions, such as fixing typos and code refactoring. -If you fixed or added something useful to the OpenToonz, please send pull-requests to us. -We review the request, then we accept it, or add comments for rework, or decline it. +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 @@ -32,21 +32,27 @@ We review the request, then we accept it, or add comments for rework, or decline ## Bugs -If you found bugs, please report details about them using [issues](https://github.com/opentoonz/opentoonz/issues). +If you find bugs, please report details about them using [issues](https://github.com/opentoonz/opentoonz/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. We believe you can fix the bug and send us the fix. +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. -Even if you cannot implement the feature, you can open a topic in [issues](https://github.com/opentoonz/opentoonz/issues). -It enables us to discuss about implementations of the feature there. +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](https://groups.google.com/forum/#!forum/opentoonz_en). +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 source (`.ts`) files for OpenToonz GUI are located in `toonz/sources/translations`. -If you create new `.ts` files for your language or polish existing ones, +If you create new `.ts` files for your language or update an existing one, 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.